DescribePortTraffic

DescribePortTraffic

1. 接口描述

本接口用于查询端口流量。

2. 请求参数

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

参数名称
是否必选
类型
描述

portId

String

端口id。

startTime

查询开始时间。

按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

endTime

查询结束时间。

按照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. 查询端口一天的带宽数据

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

Request: {
    "portId": "port-port-id"
    "startTime": "YYYY-MM-DDThh:mm:ssZ"
    "endTime": "YYYY-MM-DDThh:mm:ssZ"
}

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. 错误码

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

最后更新于