All Products
Search
Document Center

DescribeDcdnDomainBpsData

Last Updated: May 17, 2019

Description

You can call this operation to obtain bandwidth of a specified DCDN domain name. Unit: bit/s.

If you do not specify the StartTime and EndTime, you obtain bandwidth of the last 24 hours by default. To obtain the bandwidth within a certain period, you must specify both the StartTime and the EndTime.

  • You can specify multiple domain names separated with commas (,).

  • You can obtain the bandwidth of the last 90 days at most.

Request parameters

Name Type Required Description
Action String Yes The operation that you want to perform.
Set the value to DescribeDcdnDomainBpsData.
DomainName String No If you do not specify the parameter, you obtain the merged bandwidth data of all DCDN domain names by default.
You can enter the DCDN domain name that you want to query.
You can also specify multiple domain names separated with commas (,).
StartTime String No The start time of the required data. The date format follows the ISO8601 standard and uses UTC time.
Format: YYYY-MM-DDThh:mm:ssZ.
The minimum interval between the start time and the end time of the required data is 5 minutes.
If you do not specify the StartTime, you obtain the bandwidth of the last 24 hours by default.
EndTime String No The end time of the required data. The date format follows the ISO8601 standard and uses UTC time.
The end time must be later than the start time.
Format: YYYY-MM-DDThh:mm:ssZ
Interval String No The interval between the start time and the end time of the required data. Unit: seconds. Valid values:
  • Less than 3 days: 300, 3600, and 86400.
  • 3 days-31 days (excluding 31 days): 3600 and 86400.
  • No less than 31 days: 86400.
  • The default value is used if you do not specify the parameter or specify an invalid value.
LocationNameEn String No The name of the region.
You can call the DescribeCdnRegionAndIsp operation to specify the region name. If you do not set the parameter, you obtain the data of all regions.
IspNameEn String No The name of the Internet service provider (ISP).
You can call the DescribeCdnRegionAndIsp operation to specify the ISP name. If you do not set the parameter, you obtain the data of all ISPs.

Response parameters

Name Type Description
DomainName String The name of the specified DCDN domain.
StartTime DateTime The start time of the required data.
EndTime DateTime The end time of the required data.
BpsDataPerInterval DataModule[] The bandwidth data at the specified intervals.

DataModule

Name Type Description
TimeStamp String The start time of the specified time slice.
Bps Float The value of bandwidth. Unit: bit/s.
DynamicHttpBps Float The value of dynamic HTTP bandwidth. Unit: bit/s.
DynamicHttpsBps Float The value of dynamic HTTPS bandwidth. Unit: bit/s.
StaticHttpBps Float The value of static HTTP bandwidth. Unit: bit/s.
StaticHttpsBps Float The value of static HTTPS bandwidth. Unit: bit/s.

Examples

Sample requests

  1. http://dcdn.aliyuncs.com?Action=DescribeDcdnDomainBpsData&DomainName=test.com
  2. &StartTime=2017-12-10T20:00:00Z
  3. &EndTime=2017-12-10T21:00:00Z
  4. &<Common request parameters>

Sample responses

JSON format

  1. {
  2. "BpsDataPerInterval": {
  3. "DataModule": [
  4. {
  5. "TimeStamp": "2017-12-10T20:00:00Z",
  6. "Bps": 11288111,
  7. "DynamicHttpBps": 11286111,
  8. "DynamicHttpsBps": 2000,
  9. "StaticHttpBps": 0,
  10. "StaticHttpsBps": 0
  11. },
  12. {
  13. "TimeStamp": "2017-12-10T20:05:00Z",
  14. "Bps": 11288111,
  15. "DynamicHttpBps": 11286111,
  16. "DynamicHttpsBps": 2000,
  17. "StaticHttpBps": 0,
  18. "StaticHttpsBps": 0
  19. }
  20. ]
  21. },
  22. "DomainName": "test.com",
  23. "DataInterval": "300",
  24. "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  25. "StartTime": "2017-12-10T20:00:00Z",
  26. "EndTime": "2017-12-10T21:00:00Z"
  27. }

Error codes

Error code Error message HTTP status code Description
Throttling Request was denied due to request throttling. 503 The error message returned when the request was denied due to throttling.
InvalidDomain.NotFound The domain provided does not belong to you. 404 The error message returned when the specified domain name does not exist or does not belong to you.