All Products
Search
Document Center

CDN:DescribeDomainQpsDataByLayer

Last Updated:Aug 06, 2024

Queries the number of queries per second (QPS) at a specific layer for one or more accelerated domain names. You can query data collected within the last 90 days.

Operation description

  • You can call this operation up to 20 times per second per user.
  • 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 varies with the maximum time range per query. The following table describes the time period within which historical data is available and the data delay.

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeDomainQpsDataByLayernone
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name. You can specify a maximum of 500 domain names in a request. Separate multiple domain names with commas (,).

By default, this operation queries the QPS of 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 yyyy-MM-ddTHH:mm:ssZ format in the ISO 8601 standard. The time is displayed in UTC.

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

The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in the ISO 8601 standard. The time is displayed in UTC.

Note The end time must be later than the start time.
2019-11-30T05:40:00Z
IntervalstringNo

The time interval between the data entries to return. 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 Description.

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 set this parameter, all ISPs are queried.

unicom
LocationNameEnstringNo

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.

beijing
LayerstringNo

The layers at which you want to query the number of queries per second. Valid values:

  • Network layer: IPv4and IPv6.
  • Application layer: http, https, and quic.
  • all: The default value. Both the network and application layers are included.
all

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.

BEA5625F-8FCF-48F4-851B-CA63946DA664
Layerstring

The layer at which the data was collected.

all
DomainNamestring

The accelerated domain name.

example.com
DataIntervalstring

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

300
QpsDataIntervalarray<object>

The number of queries per second at each interval.

object
Valuestring

The total number of queries per second.

0.56
AccValuestring

The total number of requests.

56
AccDomesticValuestring

The number of requests in the Chinese mainland.

12
OverseasValuestring

The number of queries per second outside the Chinese mainland.

0.44
AccOverseasValuestring

The number of requests outside the Chinese mainland.

44
TimeStampstring

The timestamp of the returned data.

2015-12-10T21:00:00Z
DomesticValuestring

The number of queries per second in the Chinese mainland.

0.12

Examples

Sample success responses

JSONformat

{
  "EndTime": "2019-11-30T05:40:00Z",
  "StartTime": "2019-11-30T05:33:00Z",
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "Layer": "all",
  "DomainName": "example.com",
  "DataInterval": "300",
  "QpsDataInterval": {
    "DataModule": [
      {
        "Value": "0.56",
        "AccValue": "56",
        "AccDomesticValue": "12",
        "OverseasValue": "0.44",
        "AccOverseasValue": "44",
        "TimeStamp": "2015-12-10T21:00:00Z",
        "DomesticValue": "0.12"
      }
    ]
  }
}

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 value of parameter StartTime is malformed.The specified start time is invalid. For more information, see the help documentation of this operation.
400InvalidEndTime.MalformedThe specified value of parameter EndTime is malformed.The specified EndTime parameter is invalid.
400InvalidEndTime.MismatchSpecified EndTime does not match the specified StartTime.StartTime must be earlier than EndTime.
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.

Change history

Change timeSummary of changesOperation
2023-06-13The Error code has changedView Change Details