DescribeDomainDetailDataByLayer - CDN - Alibaba Cloud Documentation Center

Retrieves detailed data for an accelerated domain name by protocol type.

Operation description

The maximum call frequency for a single user is 20 calls per second.

Supported time granularities

The supported time granularity for a query depends on the maximum time span specified in the query. The following table describes the time granularity, the time range of historical data that you can query, and the data latency.

Time granularity	Maximum time span per query	Queryable historical data range	Data latency
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 query multiple metrics at a time. Separate multiple metrics with 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 accelerated domain name to query. You can query multiple domain names in a single request. To do so, separate the domain names with commas (,). You can specify up to 30 domain names.	example.com
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard. The format is yyyy-MM-ddTHH:mm:ssZ. The time is in UTC.	2020-07-05T22:00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard. The format is yyyy-MM-ddTHH:mm:ssZ. The time is in UTC. Note The end time must be later than the start time. The time range cannot exceed 1 hour.	2020-07-05T22:05:00Z
IspNameEn	string	No	The name of the carrier. You can call the DescribeCdnRegionAndIsp operation to query carrier names. If you do not set this parameter, data for all carriers is returned.	telecom
LocationNameEn	string	No	The name of the region. You can call the DescribeCdnRegionAndIsp operation to query region names. If you do not set this parameter, data for all regions is returned.	hangzhou
Layer	string	No	The dimension to query. Valid values are http, https, and quic for the application layer, or all. The default value is all.	all

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	BEA5625F-8FCF-48F4-851B-CA63946DA664
Data	object
DataModule	array<object>	The data returned for the accelerated domain name.
	object
Traf	integer	The traffic. Unit: bytes.	789756701818
Qps	number	The number of queries per second (QPS).	5998.47
Ipv6Qps	number	The QPS of IPv6 requests.	0
Ipv6Bps	number	The IPv6 bandwidth. Unit: bps.	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 of the time slice.	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: bps.	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.