Queries the number of queries per second (QPS) for one or more accelerated domain names.

Before you call this operation, take note of the following rules:
  • If you do not set StartTime or EndTime, data collected within the last 24 hours is queried. If you set both StartTime and EndTime, data collected within the specified time range is queried.
  • You can specify multiple domain names and separate them with commas (,).
  • You can query data collected within the last 90 days.

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 software development kits (SDKs).

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDomainQpsData

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

TimeMerge String No on

Specifies whether to merge the log entries based on the intervals. Valid values:

  • on(default): merges the intervals. The intervals of data entries are merged based on the time range.
  • off: does not merge the intervals. Data is returned every 5 minutes. The maximum time range is 31 days.
DomainType String No dynamic

The query type.

  • If you set the value to dynamic, the system queries QPS of Dynamic Route for CDN (DCDN) for dynamic content.
  • If you do not set this parameter, the system queries QPS for static content.
DomainName String No example.com

The name of the accelerated domain. You can separate multiple accelerated domain names with commas (,).

If you do not set this parameter, the usage 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 UTC.
  • The format is YYYY-MM-DDThh:mmZ.
  • The data is collected every 5 minutes.
EndTime String No 2015-12-10T21: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 UTC.
  • The format is YYYY-MM-DDThh:mmZ.
Interval String No 300

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

  • Valid values: 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 unicom

The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query the most recent ISP list. If you do not set this parameter, all ISPs are queried.

LocationNameEn String No beijing

The name of the region. 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
DataInterval String 300

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

DomainName String example.org

The accelerated domain name.

EndTime String 2015-12-10T21:00Z

The end of the time range that was queried.

QpsDataInterval Array

The QPS at each interval.

DataModule
AccDomesticValue String 0

The number of queries inside mainland China.

AccOverseasValue String 0

The number of queries outside mainland China.

AccValue String 0

The total number of queries.

DomesticValue String 0

The number of queries per second in mainland China.

DynamicDomesticValue String 0

The QPS of DCDN for dynamic content in mainland China. When the data is queried by ISP, no value is returned.

DynamicOverseasValue String 0

The QPS of DCDN for dynamic content outside mainland China. When the data is queried by ISP, no value is returned.

DynamicValue String 0

The QPS of DCDN for dynamic content.

OverseasValue String 0

The QPS outside mainland China.

StaticDomesticValue String 0

The QPS of DCDN for static content in mainland China. When the data is queried by ISP, no value is returned.

StaticOverseasValue String 0

The QPS of DCDN for static content outside mainland China. When the data is queried by ISP, no value is returned.

StaticValue String 0

The QPS of DCDN for static content. Unit: bit/s.

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

The timestamp of the data returned.

Value String 0

The total QPS.

RequestId String B8333EDB-4595-46E0-AFE9-29BAA290D0E0

The ID of the request.

StartTime String 2015-12-10T20:00Z

The start of the time range that was queried.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeDomainQpsDataResponse>
      <QpsDataInterval>
            <DataModule>
                  <TimeStamp>2015-12-10T21:00:00Z</TimeStamp>
                  <Value>0.56</Value>
                  <DomesticValue>0</DomesticValue>
                  <OverseasValue>0</OverseasValue>
                  <AccValue>0</AccValue>
                  <AccDomesticValue>0</AccDomesticValue>
                  <AccOverseasValue>0</AccOverseasValue>
                  <HttpsValue>0.56</HttpsValue>
                  <HttpsDomesticValue>0</HttpsDomesticValue>
                  <HttpsOverseasValue>0</HttpsOverseasValue>
                  <HttpsAccValue>0</HttpsAccValue>
                  <HttpsAccDomesticValue>0</HttpsAccDomesticValue>
                  <HttpsAccOverseasValue>0</HttpsAccOverseasValue>
            </DataModule>
            <DataModule>
                  <TimeStamp>2015-12-10T20:35:00Z</TimeStamp>
                  <Value>0.64</Value>
                  <DomesticValue>0</DomesticValue>
                  <OverseasValue>0</OverseasValue>
                  <AccValue>0</AccValue>
                  <AccDomesticValue>0</AccDomesticValue>
                  <AccOverseasValue>0</AccOverseasValue>
                  <HttpsValue>0.56</HttpsValue>
                  <HttpsDomesticValue>0</HttpsDomesticValue>
                  <HttpsOverseasValue>0</HttpsOverseasValue>
                  <HttpsAccValue>0</HttpsAccValue>
                  <HttpsAccDomesticValue>0</HttpsAccDomesticValue>
                  <HttpsAccOverseasValue>0</HttpsAccOverseasValue>
            </DataModule>
      </QpsDataInterval>
      <DomainName>example.com</DomainName>
      <DataInterval>300</DataInterval>
      <RequestId>BEA5625F-8FCF-48F4-851B-CA63946DA664</RequestId>
      <StartTime>2015-12-10T20:00:00Z</StartTime>
      <EndTime>2015-12-10T21:00:00Z</EndTime>
</DescribeDomainQpsDataResponse>

JSON format

{
    "QpsDataInterval": {
        "DataModule": [
            {
                "TimeStamp": "2015-12-10T21:00:00Z",
                "Value": "0.56",
                "DomesticValue": "0",
                "OverseasValue": "0",
                "AccValue": "0",
                "AccDomesticValue": "0",
                "AccOverseasValue": "0",
                "HttpsValue": "0.56",
                "HttpsDomesticValue": "0",
                "HttpsOverseasValue": "0",
                "HttpsAccValue": "0",
                "HttpsAccDomesticValue": "0",
                "HttpsAccOverseasValue": "0"
            },
            {
                "TimeStamp": "2015-12-10T20:35:00Z",
                "Value": "0.64",
                "DomesticValue": "0",
                "OverseasValue": "0",
                "AccValue": "0",
                "AccDomesticValue": "0",
                "AccOverseasValue": "0",
                "HttpsValue": "0.56",
                "HttpsDomesticValue": "0",
                "HttpsOverseasValue": "0",
                "HttpsAccValue": "0",
                "HttpsAccDomesticValue": "0",
                "HttpsAccOverseasValue": "0"
            }
        ]
    },
    "DomainName": "example.com",
    "DataInterval": "300",
    "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
    "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.