All Products
Search
Document Center

CDN:DescribeDomainQpsData

Last Updated:May 30, 2023

Queries the number of queries per second (QPS) for an accelerated domain name. The data is collected every 5 minutes. You can query data collected within the last 90 days.

Operation Description

  • You can call this operation up to 100 times per second per account.
  • 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 these parameters, the request returns the data collected within the specified time range.

Time granularity

The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the maximum time range per query, as described in the following table.

Time granularityMaximum time range per queryHistorical data availableData delay
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours
1 day366 days366 days04:00 on the next day

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cdn:DescribeDomainQpsDataREAD
  • CDN
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name. You can specify up to 500 domain names in each request. Separate multiple domain names with commas (,).

By default, this operation queries QPS data for all accelerated domain names that belong to your Alibaba Cloud account.

example.com
StartTimestringNo

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.

2019-11-30T05:33:00Z
EndTimestringNo

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.

2019-11-30T05:40:00Z
IntervalstringNo

The time granularity of the data entries. Unit: seconds.

The time granularity varies with the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes.

300
IspNameEnstringNo

The name of the Internet service provider (ISP) for your Alibaba Cloud CDN service. You can call the DescribeCdnRegionAndIsp operation to query ISPs. If you do not specify an ISP, data of all ISPs is queried.

unicom
LocationNameEnstringNo

The name of the region. You can call the DescribeCdnRegionAndIsp operation to query regions. If you do not specify a region, data in all regions is queried.

beijing

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

The end of the time range during which data was queried.

2019-11-30T05:40:00Z
StartTimestring

The start of the time range during which data was queried.

2019-11-30T05:33:00Z
RequestIdstring

The ID of the request.

B8333EDB-4595-46E0-AFE9-29BAA290D0E0
DomainNamestring

The accelerated domain name.

example.com
DataIntervalstring

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

300
QpsDataIntervalobject []

The list of QPS records at each interval.

AccValuestring

The total number of requests.

0
AccDomesticValuestring

The number of requests in the Chinese mainland.

0
AccOverseasValuestring

The number of requests outside the Chinese mainland.

0
HttpsValuestring

The number of queries per second that is calculated based on the HTTPS requests sent to points of presence (POPs).

1
HttpsOverseasValuestring

The number of queries per second that is calculated based on the HTTPS requests sent to POPs outside the Chinese mainland.

1
DomesticValuestring

The number of queries per second in the Chinese mainland.

0
HttpsAccOverseasValuestring

The number of HTTPS requests sent to POPs outside the Chinese mainland.

1
HttpsDomesticValuestring

The number of queries per second that is calculated based on the HTTPS requests sent to POPs in the Chinese mainland.

1
HttpsAccValuestring

The number of HTTPS requests sent to POPs.

1
Valuestring

The total QPS.

0
OverseasValuestring

The number of queries per second outside the Chinese mainland.

0
TimeStampstring

The timestamp of the data returned.

2019-11-30T05:40:00Z
HttpsAccDomesticValuestring

The number of HTTPS requests sent to POPs in the Chinese mainland.

1

Examples

Sample success responses

JSONformat

{
  "EndTime": "2019-11-30T05:40:00Z",
  "StartTime": "2019-11-30T05:33:00Z",
  "RequestId": "B8333EDB-4595-46E0-AFE9-29BAA290D0E0",
  "DomainName": "example.com",
  "DataInterval": "300",
  "QpsDataInterval": {
    "DataModule": [
      {
        "AccValue": "0",
        "AccDomesticValue": "0",
        "AccOverseasValue": "0",
        "HttpsValue": "1",
        "HttpsOverseasValue": "1",
        "DomesticValue": "0",
        "HttpsAccOverseasValue": "1",
        "HttpsDomesticValue": "1",
        "HttpsAccValue": "1",
        "Value": "0",
        "OverseasValue": "0",
        "TimeStamp": "2019-11-30T05:40:00Z",
        "HttpsAccDomesticValue": "1"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe specified StartTime is invalid.The format of the start time is invalid. Specify a valid value.
400InvalidEndTime.MalformedThe specified EndTime is invalid.The EndTime parameter is set in an invalid format. For more information, see the API references.
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.-
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.The specified start time is invalid. For more information, see the API references.

For a list of error codes, visit the Service error codes.