DescribeIPTransitTraffic

1. 接口描述

调用本接口用于查询IP Transit在指定时间段内的带宽数据。

注意事项

• 只能查询30天内的流量数据。

2. 请求参数

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

参数名称	必选	类型	描述
iptId	是	String	IP Transit ID。
startTime	是	Timestamp	查询开始时间。 按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。
endTime	否	Timestamp	查询结束时间。 按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。 默认为当前时间。

3. 响应结果

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

4. 代码示例

示例

1. 查询IP Transit一天内的流量数据。

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

Request:
{
  "iptId": "your-ipt-id",
  "startTime": "2024-01-01T00:00:00Z",
  "endTime": "2024-01-01T23:59:59Z"
}

Response:
{
  "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
  "response": {
    "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
    "dataList": [
      {
        "in": 873034,
        "out": 11971,
        "time": "2023-01-01T00:00:00Z"
      },
      {
        "in": 873034,
        "out": 11971,
        "time": "2023-01-01T00:05:00Z"
      },
      {
        "in": 635218,
        "out": 9028,
        "time": "2023-01-01T00:10:00Z"
      }
    ],
    "in95": 873034,
    "inAvg": 793762,
    "inMax": 873034,
    "inMin": 635218,
    "out95": 11971,
    "outAvg": 10990,
    "outMax": 11971,
    "outMin": 9028,
    "unit": "bps"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

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

HTTP状态码	错误码	说明
403	INVALID_START_TIME_MUST_BEFORE_END_TIME	开始时间必须在结束时间之前。
403	INVALID_TIME_RANGE	无效的时间范围。查询跨度必须在一天之内。
403	TIME_OUT_OF_RANGE	查询的时间必须在30天之内。
403	INVALID_TIME_FORMAT	无效的时间格式。