DescribeBandwidthClusterTraffic

1. API Description

This API (DescribeBandwidthClusterTraffic) is used to query bandwidth information of a bandwidth cluster in the specified date range.

Note

• Only the date range of 24 hours are supported.

• Only the bandwidth information within 30 days are supported to query.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
bandwidthClusterId	Yes	String	Bandwidth cluster ID.
startTime	Yes	String	Start time. Use UTC time according to the ISO8601 standard. Format: YYYY-MM-ddTHH:mm:ssZ.
endTime	Yes	String	End time. Use UTC time according to the ISO8601 standard. Format: YYYY-MM-ddTHH:mm:ssZ.
city	No	String	Filter by city, such as LAX. This value can be the name of the city or the city code. By specifying this value, only the bandwidth traffic data for that city will be returned. The city code and city name of the current bandwidth cluster can be viewed in the cities field of DescribeBandwidthClusters.

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 BandwidthClusterTrafficData	List of bandwidth data. Default value: []
in95	Integer	Inbound burstable 95th bandwidth. Default value: 0
in95Time	String	Time of inbound burstable 95th bandwidth. Format: YYYY-MM-ddTHH:mm:ssZ.
inAvg	Integer	Average value of inbound bandwidth. Default value: 0
inMax	Integer	Maximum value of inbound bandwidth. Default value: 0
inMin	Integer	Minimum value of inbound bandwidth. Default value: 0
inTotal	Integer	Total data transfer of inbound bandwidth. Default value: 0
out95	Integer	Outbound burstable 95th bandwidth. Default value: 0
out95Time	String	Time of outbound burstable 95th bandwidth. Format: YYYY-MM-ddTHH:mm:ssZ.
outAvg	Integer	Average value of outbound bandwidth. Default value: 0
outMax	Integer	Maximum value of outbound bandwidth. Default value: 0
outMin	Integer	Minimum value of outbound bandwidth. Default value: 0
outTotal	Integer	Total data transfer of outbound bandwidth. Default value: 0
maxBandwidth95ValueMbps	Float	Maximum inbound burstable 95th bandwidth. Unit: Mbps. Default value: 0
totalUnit	String	Unit of data transfer. For example, B. Default value: B
unit	String	Unit of bandwidth. For example, bps. Default value: bps

4. Code Example

Example

Query the bandwidth information of a bandwidth cluster in one day.

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

Request:
{
  "bandwidthClusterId": "bandwidthClusterId",
  "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": [
      {
        "internetRX": 873034,
        "internetTX": 11971,
        "time": "2024-01-01T00:00:00Z"
      },
      {
        "internetRX": 873034,
        "internetTX": 11971,
        "time": "2024-01-01T00:05:00Z"
      },
      {
        "internetRX": 635218,
        "internetTX": 9028,
        "time": "2024-01-01T00:10:00Z"
      }
    ],
    "in95": 873034,
    "in95Time": "2024-01-01T00:00:00Z",
    "inAvg": 793762,
    "inMax": 873034,
    "inMin": 635218,
    "inTotal": 89298270,
    "maxBandwidth95ValueMbps": 0.88,
    "out95": 11971,
    "out95Time": "2024-01-01T00:00:00Z",
    "outAvg": 10990,
    "outMax": 11971,
    "outMin": 9028,
    "outTotal": 1236457,
    "totalUnit": "B",
    "unit": "bps"
  }
}

5. 5. Developer Resources

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

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, seeCommon Error Codes.

HTTP Status Code	Error Code	Description
404	INVALID_CLUSTER_NOT_FOUND	Bandwidth cluster does not exist.