DescribeCloudRouterEdgePointTraffic

1. API Description

This API (DescribeCloudRouterEdgePointTraffic) is used to query Edge Point Traffic

Notes

• Supports bandwidth for Port, Tencent, Google, AWS, Virtual Edge, and VPC edge points.

• The span between the start time and end time cannot exceed one day.

• Only traffic data within the last 30 days can be queried.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
edgePointId	Yes	String	Cloud Router edge point ID.
startTime	Yes	String	Query start time, in ISO 8601 format, UTC timezone.
endTime	No	String	Query end time, in ISO 8601 format, UTC timezone. Defaults to the current time.

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 traffic data points.
in95	Integer	Inbound 95th percentile peak traffic.
inAvg	Integer	Average inbound traffic.
inMax	Integer	Maximum inbound traffic.
inMin	Integer	Minimum inbound traffic.
out95	Integer	Outbound 95th percentile peak traffic.
outAvg	Integer	Average outbound traffic.
outMax	Integer	Maximum outbound traffic.
outMin	Integer	Minimum outbound traffic.
unit	String	Traffic unit, e.g. bps.

4. Code Example

Example

1. Query the traffic data for an edge point in a Cloud Router over one day.

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

Request:
{
  "edgePointId": "your-cloudrouter-edge-point-id",
  "startTime": "2023-01-01T00:00:00Z",
  "endTime": "2023-01-01T23:59:59Z"
}

Response:
{
  "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
  "response": {
    "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
    "dataList": [
      {
        "internetRX": 873034,
        "internetTX": 11971,
        "time": "2023-01-01T00:00:00Z"
      },
      {
        "internetRX": 873034,
        "internetTX": 11971,
        "time": "2023-01-01T00:05:00Z"
      },
      {
        "internetRX": 635218,
        "internetTX": 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

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

HTTP Status Code	Error Code	Description
404	INVALID_CLOUD_ROUTER_POINT_NOT_FOUND	The Cloud Router edge point does not exist.