DescribeEipTraffic

1. 接口描述

本接口(DescribeEipTraffic)用于查询指定弹性公网 IP 在指定时间段内的流量监控数据，支持按统计粒度（step）聚合，可按出口公网 IP 过滤。

2. 请求参数

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

参数名称	必选	类型	描述
eipId	是	String	要查询的弹性IP ID。
startTime	是	String	查询开始时间。 按照ISO8601标准表示，并且使用UTC时间。 格式为：YYYY-MM-ddTHH🇲🇲ssZ。
endTime	是	String	查询结束时间。 按照ISO8601标准表示，并且使用UTC时间。 格式为：YYYY-MM-ddTHH🇲🇲ssZ。
step	否	Integer	查询数据点间隔。 单位为分钟。 支持参数：1,5。 默认值：5
wanIp	否	String	指定IP查询，可以指定IP地址查询流量。
direction	否	EipTrafficDirection	流量方向。 仅 PathBasedBandwidthIP 类型有效；不传则返回全部方向数据。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
dataList	Array of EipTrafficData	查询的数据点。
in95	Integer	入方向带宽95值。 单位：bps。
inAvg	Integer	入方向带宽平均值。 单位：bps。
inMax	Integer	入方向带宽的最大值。 单位：bps。
inMin	Integer	入方向带宽的最小值。 单位：bps。
inTotal	Integer	入方向的总字节。 单位：Byte。
out95	Integer	出方向带宽95值。 单位：bps。
outAvg	Integer	出方向带宽平均值。 单位：bps。
outMax	Integer	出方向带宽最大值。 单位：bps。
outMin	Integer	出方向带宽最小值。 单位：bps。
outTotal	Integer	入方向的总字节。 单位：bps。

4. 代码示例

示例

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

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

Request：
{
  "eipId": "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,
    "inAvg": 107888,
    "inMax": 109096,
    "inMin": 106680,
    "inTotal": 8091600,
    "out95": 80,
    "outAvg": 68,
    "outMax": 80,
    "outMin": 56,
    "outTotal": 5100
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明
400	INVALID_TIME_RANGE	查询时间范围不合法。
400	OPERATION_DENIED_TIME_STEP_NOT_SUPPORT	数据点间隔不支持。
400	OPERATION_DENIED_EIP_DIRECTION_NOT_SUPPORTED	direction 参数仅对 PathBasedBandwidthIP 类型 EIP 有效。