DescribePortTraffic

DescribePortTraffic

1. API Description

This API is used to query port bandwidth information in the specified date range.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
portId	Yes	String	Port ID.
startTime	Yes	Timestamp	Start time. Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.
endTime	Yes	Timestamp	End time. Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
dataList	Array of TrafficData	List of bandwidth data.
in95	Float	Inbound burstable 95th bandwidth.
inAvg	Integer	Average value of inbound bandwidth.
inMax	Integer	Maximum value of inbound bandwidth.
inMin	Integer	Minimum value of inbound bandwidth.
inTotal	Integer	Total data transfer of inbound bandwidth.
out95	Integer	Outbound burstable 95th bandwidth.
outAvg	Integer	Average value of outbound bandwidth.
outMax	Integer	Maximum value of outbound bandwidth.
outMin	Integer	Minimum value of outbound bandwidth.
unit	String	Unit of bandwidth. For example, bps.

4. Code Example

Example

Query the bandwidth information of the instance in one day.

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. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​