Queries bandwidth monitoring data for one or more accelerated domain names.

Note
  • If you do not set the StartTime or EndTime parameter, data collected within the last 24 hours is queried. If you set both the StartTime and EndTime parameters, data collected within the specified time range is queried.
  • You can query data within the last 90 days. Bandwidth data is measured in bit/s.
  • If you use this operation to query bandwidth monitoring data of all regions and Internet service providers (ISPs), data accuracy may decrease. We recommend that you use this operation to query bandwidth monitoring data of a specific region and ISP.

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 DescribeDomainBpsData

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

TimeMerge String No on

Specifies whether to merge the data entries. Valid values:

  • on(default): merges the data entries based on the time range.
  • off: returns data entries collected every 5 minutes. The maximum time range can be 31 days.
DomainType String No dynamic

The query type.

  • If this parameter is set to dynamic, the real-time bandwidth values for delivering dynamic resources and static resources are queried.
  • If you do not specify a value, real-time bandwidth values for delivering only static resources are queried.
DomainName String No example.com

The accelerated domain names. Separate accelerated domain names with commas (,).

If you do not set this parameter, the bandwidth monitoring data of all accelerated domain names is returned.

StartTime String No 2015-12-10T20: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.
  • The data is collected every 5 minutes.
  • If you do not set this parameter, data within the last 24 hours is queried.
EndTime String No 2015-12-10T20:00Z

The end of the time range to query.

  • The end time must be later than the start time.
  • Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.
  • The time must be in UTC.
Interval String No 300

The time interval between the data entries. Unit: seconds.

  • Valid values are 300, 3600, 14400, 28800, and 86400.
  • The default value is 300. If you do not set this parameter or if you specify an invalid value, the default value is used.
IspNameEn String No telecom

The name of the ISP. You can call the DescribeCdnRegionAndIsp operation to query ISPs. If you do not set this parameter, all ISPs are queried.

LocationNameEn String No beijing

The name of the region in which you want to query the data. You can call the DescribeCdnRegionAndIsp operation to query the most recent region list. If you do not set this parameter, all regions are queried.

Response parameters

Parameter Type Example Description
BpsDataPerInterval Array of DataModule

The bandwidth values collected at each interval.

DataModule
DomesticL2Value String 0

The bandwidth values of L2 CDN edge nodes in mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.

DomesticValue String 11286111

The bandwidth values in mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.

DynamicDomesticValue String 0

The bandwidth values for delivering dynamic resources in mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.

DynamicOverseasValue String 0

The bandwidth values for delivering dynamic resources outside mainland China. Unit: bit/s When the bandwidth data is queried by ISP, no value is returned.

DynamicValue String 0

The bandwidth values for delivering dynamic resources. Unit: bit/s.

L2Value String 0

The bandwidth values of L2 CDN edge nodes. Unit: bit/s.

OverseasL2Value String 0

The bandwidth values of L2 CDN edge nodes outside mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.

OverseasValue String 2000

The bandwidth values in regions outside mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.

StaticDomesticValue String 0

The bandwidth values for delivery static resources in mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.

StaticOverseasValue String 0

The bandwidth values for delivery static resources outside mainland China. Unit: bit/s. When the bandwidth data is queried by ISP, no value is returned.

StaticValue String 0

The bandwidth values for delivering static resources. Unit: bit/s.

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

The timestamp of the data returned.

Value String 11288111

The bandwidth value. Unit: bit/s.

DataInterval String 300

The interval between data entries. Unit: second.

DomainName String example.com

The accelerated domain name.

EndTime String 2015-12-10T20:00Z

The end of the time range that was queried.

IspName String China Unicom

The name of the ISP.

IspNameEn String unicom

The English name of the ISP.

LocationName String Beijing

The name of the region.

LocationNameEn String beijing

The English name of the region.

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

The ID of the request.

StartTime String 2015-12-10T20:00Z

The beginning of the time range that was queried.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeDomainBpsData
&<Common request parameters>

Sample success responses

XML format

<DescribeDomainBpsDataResponse>
      <BpsDataPerInterval>
            <DataModule>
                  <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>
                  <Value>11288111</Value>
                  <DomesticValue>11286111</DomesticValue>
                  <OverseasValue>2000</OverseasValue>
                  <HttpsValue>11288111</HttpsValue>
                  <HttpsDomesticValue>11286111</HttpsDomesticValue>
                  <HttpsOverseasValue>2000</HttpsOverseasValue>
            </DataModule>
            <DataModule>
                  <TimeStamp>2015-12-10T20:05:00Z</TimeStamp>
                  <Value>12124821</Value>
                  <DomesticValue>12112821</DomesticValue>
                  <OverseasValue>12000</OverseasValue>
                  <HttpsValue>11288111</HttpsValue>
                  <HttpsDomesticValue>11286111</HttpsDomesticValue>
                  <HttpsOverseasValue>2000</HttpsOverseasValue>
            </DataModule>
      </BpsDataPerInterval>
      <DomainName>example.com</DomainName>
      <DataInterval>300</DataInterval>
      <RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
      <StartTime>2015-12-10T20:00:00Z</StartTime>
      <EndTime>2015-12-10T21:00:00Z</EndTime>
</DescribeDomainBpsDataResponse>

JSON format

{
    "BpsDataPerInterval": {
        "DataModule": [
            {
                "TimeStamp": "2015-12-10T20:00:00Z",
                "Value": "11288111",
                "DomesticValue": "11286111",
                "OverseasValue": "2000",
                "HttpsValue": "11288111",
                "HttpsDomesticValue": "11286111",
                "HttpsOverseasValue": "2000"
            },
            {
                "TimeStamp": "2015-12-10T20:05:00Z",
                "Value": "12124821",
                "DomesticValue": "12112821",
                "OverseasValue": "12000",
                "HttpsValue": "11288111",
                "HttpsDomesticValue": "11286111",
                "HttpsOverseasValue": "2000"
            }
        ]
    },
    "DomainName": "example.com",
    "DataInterval": "300",
    "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
    "StartTime": "2015-12-10T20:00:00Z",
    "EndTime": "2015-12-10T21:00:00Z"
}

Error codes

HttpCode Error code Error message Description
400 InvalidStartTime.Malformed Specified StartTime is malformed. The error message returned because the format of the specified start time is invalid. For more information about the time format, see the Request parameters section.
400 InvalidEndTime.Malformed Specified EndTime is malformed. The error message returned because the format of the specified end time is invalid. For more information about the time format, see the Request parameters section.
400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported. The error message returned because the specified start time is invalid. Rectify the start time and try again.

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