DescribeInstanceTraffic

DescribeInstanceTraffic

1. 接口描述

调用本接口用于查询实例指定时间段内的流量信息。

注意事项

• 开始时间和结束时间的跨度不能超过一天。

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

2. 请求参数

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

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

3. 响应结果

名称	类型	描述
requestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。
dataList	Array of InstanceTrafficData	带宽数据列表。
in95	Integer	入口带宽95值。
in95Time	String	入口带宽95值时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
inAvg	Integer	入口带宽平均值。
inMax	Integer	入口带宽最大值。
inMin	Integer	入口带宽最小值。
inTotal	Integer	入口带宽总流量。
maxBandwidth95ValueMbps	Float	最大带宽95值。单位：Mbps。
out95	Integer	出口带宽95值。
out95Time	String	出口带宽95值时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
outAvg	Integer	出口带宽平均值。
outMax	Integer	出口带宽最大值。
outMin	Integer	出口带宽最小值。
outTotal	Integer	出口带宽总流量。
totalUnit	String	总流量单位。例如：B。
unit	String	带宽值单位。例如：bps。

4. 代码示例

示例

1. 查询实例一段时间内的流量数据。

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

Request:
{
  "instanceId": "926368879272403391",
  "startTime": "2023-07-11T08:00:011Z",
  "endTime": "2023-07-11T08:10:00Z"
}

Response:
{
  "requestId": "TE1375F34-6DC9-4BED-BDF2-DC9D07E4D3A6",
  "response": {
    "requestId": "TE1375F34-6DC9-4BED-BDF2-DC9D07E4D3A6",
    "dataList": [
      {
        "internetRX": 109096,
        "internetTX": 80,
        "time": "2023-07-11T08:05:00Z"
      },
      {
        "internetRX": 106680,
        "internetTX": 56,
        "time": "2023-07-11T08:10:00Z"
      }
    ],
    "in95": 109096,
    "in95Time": "2023-07-11T08:05:00Z",
    "inAvg": 107888,
    "inMax": 109096,
    "inMin": 106680,
    "inTotal": 8091600,
    "out95": 80,
    "out95Time": "2023-07-11T08:05:00Z",
    "outAvg": 68,
    "outMax": 80,
    "outMin": 56,
    "outTotal": 5100,
    "maxBandwidth95ValueMbps": 0.11,
    "totalUnit": "B",
    "unit": "bps"
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明
404	INVALID_INSTANCE_NOT_FOUND	指定的实例不存在。
403	INVALID_START_TIME_MUST_BEFORE_END_TIME	开始时间必须在结束时间之前。
403	INVALID_TIME_RANGE	无效的时间范围。查询跨度必须在一天之内。
403	TIME_OUT_OF_RANGE	查询的时间必须在30天之内。