Call DescribeDomainQpsDataByLayer to query QPS data by layer - CDN

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

Each account can call this operation up to 20 times per second.
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 granularity	Maximum time range per query	Historical data available	Data delay
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	4 hours
1 day	366 days	366 days	04:00 on the next day

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:DescribeDomainQpsDataByLayer

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	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
StartTime	string	No	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
EndTime	string	No	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
Interval	string	No	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
IspNameEn	string	No	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
LocationNameEn	string	No	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
Layer	string	No	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 elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2019-11-30T05:40:00Z
StartTime	string	The start of the time range during which data was queried.	2019-11-30T05:33:00Z
RequestId	string	The ID of the request.	BEA5625F-8FCF-48F4-851B-CA63946DA664
Layer	string	The layer at which the data was collected.	all
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	300
QpsDataInterval	object
DataModule	array<object>	The number of queries per second at each interval.
	object
Value	string	The total number of queries per second.	0.56
AccValue	string	The total number of requests.	56
AccDomesticValue	string	The number of requests in the Chinese mainland.	12
OverseasValue	string	The number of queries per second outside the Chinese mainland.	0.44
AccOverseasValue	string	The number of requests outside the Chinese mainland.	44
TimeStamp	string	The timestamp of the returned data.	2015-12-10T21:00:00Z
DomesticValue	string	The number of queries per second in the Chinese mainland.	0.12

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	StartTime must be earlier than EndTime.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid. For more information, see the API references.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.