---
title: "查询实例vnStat流量数据"
method: GET
path: "/user/instances/{instance_id}/vnstat/query"
tags: ["用户管理"]
---

# 查询实例vnStat流量数据

`GET /user/instances/{instance_id}/vnstat/query`

根据查询条件获取实例的vnStat流量数据，支持按类型、时间范围查询

## Path parameters

- `instance_id` integer, required

## Query parameters

- `interface` string
- `type` string
- `period` string
- `start_date` string
- `end_date` string
- `limit` integer

## Response `200`

查询成功

- object
  - `code` integer
  - `data` MonitoringVnStatResponse
    - `interfaces` MonitoringVnStatInterfaceData[]
      - `alias` string
      - `created` MonitoringVnStatTimestamp
        - `date` MonitoringVnStatDate
          - `day` integer
          - `month` integer
          - `year` integer
        - `time` MonitoringVnStatTime
          - `hour` integer
          - `minute` integer
        - `timestamp` integer — v2+ 才有
      - `name` string
      - `traffic` MonitoringVnStatTrafficData
        - `day` MonitoringVnStatDayRecord[] — v2 使用
          - `date` MonitoringVnStatDate
            - `day` integer
            - `month` integer
            - `year` integer
          - `id` integer — v2+ 才有
          - `rx` integer
          - `timestamp` integer — v2+ 才有
          - `tx` integer
        - `days` MonitoringVnStatDayRecord[] — v1 格式字段 (复数形式)
          - `date` MonitoringVnStatDate
            - `day` integer
            - `month` integer
            - `year` integer
          - `id` integer — v2+ 才有
          - `rx` integer
          - `timestamp` integer — v2+ 才有
          - `tx` integer
        - `fiveminute` MonitoringVnStatFiveMinRecord[] — v2 格式字段 (单数形式)
          - `date` MonitoringVnStatDate
            - `day` integer
            - `month` integer
            - `year` integer
          - `id` integer
          - `rx` integer
          - `time` MonitoringVnStatTime
            - `hour` integer
            - `minute` integer
          - `timestamp` integer
          - `tx` integer
        - `hour` MonitoringVnStatHourRecord[] — v2+ 新增
          - `date` MonitoringVnStatDate
            - `day` integer
            - `month` integer
            - `year` integer
          - `id` integer
          - `rx` integer
          - `time` MonitoringVnStatTime
            - `hour` integer
            - `minute` integer
          - `timestamp` integer
          - `tx` integer
        - `month` MonitoringVnStatMonthRecord[] — v2 使用
          - `date` MonitoringVnStatDate
            - `day` integer
            - `month` integer
            - `year` integer
          - `id` integer — v2+ 才有
          - `rx` integer
          - `timestamp` integer — v2+ 才有
          - `tx` integer
        - `months` MonitoringVnStatMonthRecord[] — v1 使用
          - `date` MonitoringVnStatDate
            - `day` integer
            - `month` integer
            - `year` integer
          - `id` integer — v2+ 才有
          - `rx` integer
          - `timestamp` integer — v2+ 才有
          - `tx` integer
        - `top` MonitoringVnStatTopRecord[] — v2 使用
          - `date` MonitoringVnStatDate
            - `day` integer
            - `month` integer
            - `year` integer
          - `id` integer — v2+ 才有
          - `rx` integer
          - `timestamp` integer — v2+ 才有
          - `tx` integer
        - `tops` MonitoringVnStatTopRecord[] — v1 使用
          - `date` MonitoringVnStatDate
            - `day` integer
            - `month` integer
            - `year` integer
          - `id` integer — v2+ 才有
          - `rx` integer
          - `timestamp` integer — v2+ 才有
          - `tx` integer
        - `total` MonitoringVnStatTotal
          - `rx` integer
          - `tx` integer
        - `year` MonitoringVnStatYearRecord[] — v2+ 新增
          - `date` MonitoringVnStatDate
            - `day` integer
            - `month` integer
            - `year` integer
          - `id` integer
          - `rx` integer
          - `timestamp` integer
          - `tx` integer
      - `updated` MonitoringVnStatTimestamp
        - `date` MonitoringVnStatDate
          - `day` integer
          - `month` integer
          - `year` integer
        - `time` MonitoringVnStatTime
          - `hour` integer
          - `minute` integer
        - `timestamp` integer — v2+ 才有
    - `jsonversion` string
    - `vnstatversion` string
  - `msg` string

## Other responses

- `400` — 参数错误
- `401` — 用户未登录
- `403` — 无权限访问该实例
- `404` — 实例不存在
- `500` — 查询失败

## Changes

- **2025-10-22** `dcdf027169a3` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/oneclickvirt/apis/oneclickvirt-api/changes/user/instances/:instance_id/vnstat/query/get.md)

---

[API](https://skmtc.dev/oneclickvirt/apis/oneclickvirt-api.md) · [All operations](https://skmtc.dev/oneclickvirt/apis/oneclickvirt-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oneclickvirt/oneclickvirt-api/revisions/dcdf027169a3/schema)