DescribeTraffic

1. 接口描述

本接口(DescribeTraffic)用于查询zga流量。

注意事项

• 带宽返回值时间颗粒度为 300s。

• 带宽和流量数据是通过加速日志汇总得到。由于日志采集得延时性，当前带宽值可能出现 0 或者不准的情况。一般情况下，15 分钟前数据完整性没有问题，可设置 endTime=(当前时间-15 分钟)再向前取 5 的倍数时间查询（详见入参说明）。由于可能会遇到一些数据收集延迟的情况，每个点的数据在 24 小时内有几率被修正。如果对数据完整性要求是 100%，可以在 24 小时后调用，进行数据覆盖。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
startTime	是	String	获取数据起始时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ，例如2024-08-22T00:00:00Z
endTime	是	String	获取数据结束时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ，例如2024-08-22T00:10:00Z。结束时间点需要大于起始时间
acceleratorIds	否	Array of String	加速器ID。 * 查询多个加速器流量汇总数据。 * 默认查询客户流量汇总数据。
originRegionId	否	String	原站区域 Id 与accelerateRegionId同时配置，查询线路流量汇总数据。
accelerateRegionId	否	String	加速区域 Id 与originRegionId同时配置，查询线路流量汇总数据。
resourceGroupId	否	String	资源组的 ID。 查询资源组流量汇总数据。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。
dataList	Array of AcceleratorTrafficData	带宽数据列表
inMax	Integer	入口带宽最大值
inMin	Integer	入口带宽最小值
inTotal	Integer	入口带宽总流量
outMax	Integer	出口带宽最大值
outMin	Integer	出口带宽最小值
outTotal	Integer	出口带宽总流量
unit	String	带宽值单位。例如：bps
totalUnit	String	流量值单位。例如：B

4. 代码示例

示例

1. 查询zga流量。

POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/zga
Content-Type: application/json
X-TC-Action: DescribeTraffic
<Common Request Params>

Request:
{
  "startTime": "2025-11-19T07:00:00Z", 
  "endTime": "2025-11-19T07:20:00Z"
}
Response:
{
    "requestId": "TB3288525-E0E7-400F-9053-34BAB27E5CCF",
    "response": {
        "requestId": "TB3288525-E0E7-400F-9053-34BAB27E5CCF",
        "dataList": [
            {
                "internetRX": 2054,
                "internetTX": 13579,
                "time": "2025-11-19T07:00:00Z"
            },
            {
                "internetRX": 3452,
                "internetTX": 22814,
                "time": "2025-11-19T07:05:00Z"
            },
            {
                "internetRX": 82,
                "internetTX": 543,
                "time": "2025-11-19T07:10:00Z"
            },
            {
                "internetRX": 0,
                "internetTX": 0,
                "time": "2025-11-19T07:15:00Z"
            }
        ],
        "inMax": 3452,
        "inMin": 0,
        "inTotal": 209589,
        "outMax": 22814,
        "outMin": 0,
        "outTotal": 1385146,
        "totalUnit": "B",
        "unit": "bps"
    }
}

5. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP 状态码	错误码	说明
400	INVALID_START_TIME_MUST_BEFORE_END_TIME	开始时间必须在结束时间之前
404	INVALID_REGION_NOT_FOUND	未找到指定区域