DescribeDomainDetailDataByLayer-阿里云帮助中心

Queries the detailed data of accelerated domain names by protocol type at the domain name level.

Operation description

The maximum invoke frequency for a single user is 20 times per second.

Supported time granularities for queries

The request parameter Interval supports different data timestamp granularities based on the maximum time span of a single query. The corresponding time range of queryable historical data and the data delay are as follows:

Time granularity	Maximum time span for a single query	Time range of queryable historical data	Data delay
5 minutes	1 hour	93 days	15 minutes

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:DescribeDomainDetailDataByLayer

none

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
Field	string	Yes	The metrics to query. You can specify multiple metrics separated by commas (,). Valid values: bps, qps, traf, acc, ipv6_traf, ipv6_bps, ipv6_acc, ipv6_qps, and http_code.	bps,ipv6_traf,traf,http_code,qps
DomainName	string	Yes	The domain names to query. You can specify multiple domain names separated by commas (,). A maximum of 30 domain names can be queried at a time.	example.com
StartTime	string	Yes	The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2020-07-05T22:00:00Z
EndTime	string	Yes	The end time of the data to retrieve. 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, and the interval cannot exceed 1 hour.	2020-07-05T22:05:00Z
IspNameEn	string	No	The English name of the ISP. You can call the DescribeCdnRegionAndIsp operation to query ISPs. If you do not specify this parameter, all ISPs are queried.	telecom
LocationNameEn	string	No	The English name of the region. You can call the DescribeCdnRegionAndIsp operation to query regions. If you do not specify this parameter, all regions are queried.	hangzhou
Layer	string	No	The query dimension. Valid values: application layer protocols (http, https, and quic) and all. Default value: all.	all

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	BEA5625F-8FCF-48F4-851B-CA63946DA664
Data	object
DataModule	array<object>	The data returned for the queried accelerated domain names.
	object
Traf	integer	The traffic. Unit: bytes.	789756701818
Qps	number	The queries per second (QPS).	5998.47
Ipv6Qps	number	The IPv6 QPS.	0
Ipv6Bps	number	The IPv6 bandwidth. Unit: bit/s.	0
Acc	integer	The number of requests.	2
Ipv6Traf	integer	The IPv6 traffic. Unit: bytes.	141718944482
Ipv6Acc	integer	The number of IPv6 requests.	1
TimeStamp	string	The start time of the time slice. The time is displayed in the ISO 8601 standard in UTC.	2020-07-05T22:00:00Z
HttpCode	string	The distribution of HTTP status codes.	200:44349\|206:1753719\|304:45\|403:1095\|416:1\|499:332
Bps	number	The bandwidth. Unit: bit/s.	21060178715.146667
DomainName	string	The domain name.	example.com

Examples

Success response

JSON format

{
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "Data": {
    "DataModule": [
      {
        "Traf": 789756701818,
        "Qps": 5998.47,
        "Ipv6Qps": 0,
        "Ipv6Bps": 0,
        "Acc": 2,
        "Ipv6Traf": 141718944482,
        "Ipv6Acc": 1,
        "TimeStamp": "2020-07-05T22:00:00Z",
        "HttpCode": "200:44349|206:1753719|304:45|403:1095|416:1|499:332",
        "Bps": 21060178715.146667,
        "DomainName": "example.com"
      }
    ]
  }
}

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 value of parameter StartTime is not supported.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.