DescribeDcdnDomainQpsDataByLayer - Edge Security Acceleration

Call DescribeDcdnDomainQpsDataByLayer to query the queries per second (QPS) of an accelerated domain name by protocol.

Operation description

Note

A single user can make up to 20 calls per second.
If you do not specify StartTime and EndTime, data in the last 24 hours is returned by default. If you specify StartTime and EndTime, data in the specified time range is returned.

Supported time granularities

The time granularity that you can specify in the Interval parameter varies based on the maximum time span of a single query. The following table lists the queryable historical data range and data latency for each time granularity.

Time granularity	Maximum time span for a single query	Queryable historical data range	Data latency
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	Typically 3 to 4 hours
1 day	366 days	366 days	Typically 4 hours, but no more than 24 hours

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

dcdn:DescribeDcdnDomainQpsDataByLayer

get

*Domain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name that you want to query. You can specify multiple domain names. Separate them with commas (,). You can specify up to 500 domain names. If you specify multiple domain names, the data is aggregated. If you leave this parameter empty, the aggregated data for all your accelerated domain names is returned.	example.com
StartTime	string	No	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 minimum time granularity is 5 minutes. If you do not set this parameter, data in the last 24 hours is returned.	2015-12-10T20:00:00Z
EndTime	string	No	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. Note The end time must be later than the start time.	2015-12-10T21:00:00Z
Interval	string	No	The time granularity for the query, in seconds. Valid values are 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). The supported value depends on the maximum time span of a single query. For more information, see the table of supported time granularities in this topic.	300
IspNameEn	string	No	The English name of the carrier. Call the DescribeDcdnRegionAndIsp operation to obtain the name. If you do not set this parameter, data for all carriers is returned.	telecom
LocationNameEn	string	No	The English name of the region. Call the DescribeDcdnRegionAndIsp operation to obtain the name. If you do not set this parameter, data for all regions is returned.	hangzhou
Layer	string	No	The layer to query. Valid values: `network` (IPv4 and IPv6), `application` (HTTP, HTTPS, and QUIC), or `all`. The default value is `all`.	all

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range that was queried.	2015-12-10T21:00:00Z
StartTime	string	The beginning of the time range that was queried.	2015-12-10T20:00:00Z
RequestId	string	The request ID.	BEA5625F-8FCF-48F4-851B-CA63946DA664
Layer	string	The layer that was queried.	all
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between each data record. Unit: seconds.	300
QpsDataInterval	object
DataModule	array<object>	The QPS value for each time interval.
	object
Value	string	The total QPS.	0.56
AccValue	string	The total number of requests.	56
AccDomesticValue	string	The number of requests in the Chinese mainland.	12
OverseasValue	string	The QPS in regions outside the Chinese mainland.	0.44
AccOverseasValue	string	The number of requests in regions outside the Chinese mainland.	44
TimeStamp	string	The beginning of the time slice.	2015-12-10T21:00:00Z
DomesticValue	string	The QPS in the Chinese mainland.	0.12

Examples

Success response

JSON format

{
  "EndTime": "2015-12-10T21:00:00Z",
  "StartTime": "2015-12-10T20:00: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 StartTime parameter is invalid.	The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.