Queries the bandwidth data for one or more specified accelerated domains. You can query the data in the last 90 days.

Before you call this operation, pay attention to the following notes:
  • The bandwidth is measured in bit/s.
  • If you specify neither StartTime nor EndTime, the data in the last 24 hours is returned. If you specify both StartTime and EndTime, the data in the specified time range is returned.
  • You can specify multiple accelerated domain names and separate them with commas (,).
  • The data is collected every 5 minutes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDcdnDomainBpsData

The operation that you want to perform. Set the value to DescribeDcdnDomainBpsData.

DomainName String No example.com

The name of the accelerated domain for which you want to query the data. You can specify multiple accelerated domain names and separate them with commas (,).

By default, all accelerated domains are queried.

StartTime String No 2017-12-10T20:00:00Z

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.

EndTime String No 2017-12-10T21:00:00Z

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.

The end time must be later than the start time.

Interval String No 300

The time interval between the data entries. Unit: seconds. The valid values vary based on the values of the StartTime and EndTime parameters. Valid values:

  • If the time span between StartTime and EndTime is less than 3 days, valid values are 300, 3600, and 86400. Default value: 300.
  • If the time span between StartTime and EndTime is from 3 to 31 days (31 days excluded), valid values are 3600 and 86400. Default value: 3600.
  • If the time span between StartTime and EndTime is 31 days or longer, the valid value is 86400. Default value: 86400.
IspNameEn String No beijing

The name of the Internet service provider (ISP). To query ISPs, call the DescribeCdnRegionAndIsp operation. If you do not specify this parameter, the data of the accelerated domains for all ISPs is returned.

LocationNameEn String No unicom

The name of the region. To query regions, call the DescribeCdnRegionAndIsp operation. If you do not specify this parameter, the data of the accelerated domains in all regions is returned.

Response parameters

Parameter Type Example Description
BpsDataPerInterval Array

The bandwidth data returned at each interval.

DataModule
Bps Float 11286

The bandwidth data, in bit/s.

DynamicHttpBps Float 11286111

The bandwidth consumed to deliver dynamic content over HTTP, in bit/s.

DynamicHttpsBps Float 12312

The bandwidth consumed to deliver dynamic content over HTTPS, in bit/s.

StaticHttpBps Float 123

The bandwidth consumed to deliver static content over HTTP, in bit/s.

StaticHttpsBps Float 123

The bandwidth consumed to deliver static content over HTTPS, in bit/s.

TimeStamp String 2017-12-10T20:00:00Z

The timestamp of the data returned.

DataInterval String 300

The time interval between the data entries.

DomainName String example.com

The name of the accelerated domain for which the data was returned.

EndTime String 2017-12-10T21:00:00Z

The end of the time range where the data was queried.

RequestId String 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F

The ID of the request.

StartTime String 2017-12-10T10:00:00Z

The beginning of the time range where the data was queried.

Examples

Sample requests

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

Sample responses

XML format

<DescribeDcdnDomainBpsDataResponse>
	  <BpsDataPerInterval>
		    <DataModule>
			      <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
			      <Bps>11288111</Bps>
			      <DynamicHttpBps>11286111</DynamicHttpBps>
			      <DynamicHttpsBps>2000</DynamicHttpsBps>
			      <StaticHttpBps>0</StaticHttpBps>
			      <StaticHttpsBps>0</StaticHttpsBps>
		    </DataModule>
		    <DataModule>
			      <TimeStamp>2017-12-10T20:05:00Z</TimeStamp>
			      <Bps>11288111</Bps>
			      <DynamicHttpBps>11286111</DynamicHttpBps>
			      <DynamicHttpsBps>2000</DynamicHttpsBps>
			      <StaticHttpBps>0</StaticHttpBps>
			      <StaticHttpsBps>0</StaticHttpsBps>
		    </DataModule>
	  </BpsDataPerInterval>
	  <DomainName>test.com</DomainName>
	  <DataInterval>300</DataInterval>
	  <RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
	  <StartTime>2017-12-10T20:00:00Z</StartTime>
	  <EndTime>2017-12-10T21:00:00Z</EndTime>
</DescribeDcdnDomainBpsDataResponse>

JSON format

{
    "BpsDataPerInterval": {
        "DataModule": [
            {
                "TimeStamp": "2017-12-10T20:00:00Z",
                "Bps": 11288111,
                "DynamicHttpBps": 11286111,
                "DynamicHttpsBps": 2000,
                "StaticHttpBps": 0,
                "StaticHttpsBps": 0
            },
            {
                "TimeStamp": "2017-12-10T20:05:00Z",
                "Bps": 11288111,
                "DynamicHttpBps": 11286111,
                "DynamicHttpsBps": 2000,
                "StaticHttpBps": 0,
                "StaticHttpsBps": 0
            }
        ]
    },
    "DomainName": "test.com",
    "DataInterval": "300",
    "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
    "StartTime": "2017-12-10T10:00:00Z",
    "EndTime": "2017-12-10T21:00:00Z"
}

Error codes

HttpCode Error code Error message Description
400 MissingTimeParameter The StartTime and EndTime must be both specified. The error message returned because both the StartTime and EndTime parameters must be specified.
400 InvalidEndTime.Malformed The specified EndTime is invalid. The error message returned because 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 error message returned because the specified end time is earlier than the specified start time.
400 InvalidStartTime.ValueNotSupported The specified StartTime is invalid. The error message returned because the specified start time is invalid.

For a list of error codes, visit the API Error Center.