DescribePrivateConnectTraffic
1. API Description
This API is used to query private connect bandwidth information 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 |
---|---|---|---|
privateConnectId | Yes | String | Private connect ID. |
startTime | Yes | Start time. Use UTC time according to the ISO8601 standard. Format: | |
endTime | No | End time. Use UTC time according to the ISO8601 standard. Format: |
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 | 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, |
4. Code Example
Query the bandwidth information of a private connect in one day.
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 Code
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_PRIVATE_CONNECT_NOT_FOUND | Private connect does not exist. |
403 | INVALID_START_TIME_MUST_BEFORE_END_TIME | The start time should be earlier than the end time. |
403 | INVALID_TIME_RANGE | Invalid date range. The date range should be within 24 hours. |
403 | TIME_OUT_OF_RANGE | Only the bandwidth information within 30 days are supported to query. |
403 | INVALID_TIME_FORMAT | Invalid time format. |
Last updated