Queries bandwidth data for Border Gateway Protocol (BGP) accelerated domain names. Data is collected every 5 minutes.
Operation description
- If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range. You must set both parameters or leave both of them empty.
- If you specify multiple Internet service providers (ISPs), the data for the ISPs is aggregated.
- You can query data in the last 90 days.
- The maximum time range from the start time to the end time is 31 days. The start time is specified by the StartTime parameter and the end time is specified by the EndTime parameter.
- If the time range from the start time to the end time is 72 hours or shorter, you can specify the interval as 5 minutes. If the time range is longer than 72 hours, you must specify the interval as 1 hour.
- You can call this operation up to five times per second per account.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Isp | string | No | The ISPs. If you need to specify multiple ISPs, separate them with commas (,). If you specify multiple ISPs, the data for the ISPs is aggregated. If you do not specify this parameter, the operation returns the data for all the ISPs. Valid values:
| cu |
| StartTime | string | No | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The minimum data collection interval is an hour. If you do not set this parameter, data collected in the last 24 hours is queried. | 2018-11-29T00:00:00Z |
| EndTime | string | No | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2018-11-30T00:00:00Z |
| Interval | string | No | The data collection interval. Unit: seconds. Valid values: 300 and 3600. Default value: 300. The default value of 300 seconds is equal to 5 minutes. The value of this parameter varies based on the time range from the specified start time to the specified end time. | 300 |
| DeviceName | string | No | The name of the device. If you specify this parameter, the data of the device is returned. Otherwise, the data of all devices is returned. | devicename |
| DevicePort | string | No | The port of the device. If you specify this parameter, the data of the port is returned. Otherwise, the data of all ports is returned. This parameter takes effect only when the DeviceName parameter is specified. | 123 |
Response parameters
Examples
Sample success responses
JSONformat
{
"EndTime": "2018-11-30T00:00:00Z",
"StartTime": "2018-11-29T00:00:00Z",
"RequestId": "E9D3257A-1B7C-414C-90C1-8D07AC47BCAC",
"BgpDataInterval": [
{
"Out": 183,
"In": 318,
"TimeStamp": "2018-11-29T20:00:00Z"
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | MissingTimeParameter | The StartTime and EndTime must be both specified. | You must set both the start time and the end time. |
| 400 | InvalidStartTime.Malformed | The specified StartTime parameter is invalid. | The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
| 400 | InvalidEndTime.Malformed | The specified EndTime is invalid. | The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
| 400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | The end time is earlier than the start time. |
| 400 | InvalidStartTime.ValueNotSupported | The specified StartTime is invalid. | The specified start time is invalid. |
For a list of error codes, visit the Service error codes.