DescribeDomainDetailDataByLayer - API Reference| Alibaba Cloud Documentation Center

Description

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


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 days	366 days	366 days	04: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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDomainDetailDataByLayer	The operation that you want to perform. Set the value to DescribeDomainDetailDataByLayer.
Field	String	Yes	bps,ipv6_traf,traf,http_code,qps	The metric that you want to query. You can specify one or more metrics and separate them with commas (,). Valid values: bps, qps, traf, acc, ipv6_traf, ipv6_bps, ipv6_acc, ipv6_qps, and http_code.
DomainName	String	Yes	example.com	The domain name that you want to query. You can specify multiple domain names and separate them with commas (,). You can specify at most 30 domain names in each call.
StartTime	String	Yes	2020-07-05T22:00:00Z	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.
EndTime	String	Yes	2020-07-05T22:05:00Z	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.
IspNameEn	String	No	telecom	The name of the Internet service provider (ISP) for your Alibaba Cloud CDN service. You can call the DescribeCdnRegionAndIsp operation to query ISP names. If you do not specify an ISP, data of all ISPs is queried.
LocationNameEn	String	No	hangzhou	The name of the region. You can call the DescribeCdnRegionAndIsp operation to query regions. If you do not specify a region, data in all regions is queried.
Layer	String	No	all	The protocol by which you want to query data. Valid values: http, https, quic, and all. The default value is all.

Response parameters


Parameter	Type	Example	Description
RequestId	String	BEA5625F-8FCF-48F4-851B-CA63946DA664	The ID of the request.
Data	Array of DataModule		The detailed data of the accelerated domain names.
DataModule
Traf	Long	789756701818	The amount of network traffic. Unit: bytes.
Qps	Float	5998.47	The number of queries per second.
Ipv6Qps	Float	0	The number of IPv6 requests per second.
Ipv6Bps	Float	0	The bandwidth of IPv6 requests. Unit: bit/s.
Acc	Long	2	The number of requests.
Ipv6Traf	Long	141718944482	The amount of network traffic generated by IPv6 requests. Unit: bytes.
Ipv6Acc	Long	1	The number of IPv6 requests.
TimeStamp	String	2020-07-05T22:00:00Z	The timestamp of the data returned.
HttpCode	String	200:44349\|206:1753719\|304:45\|403:1095\|416:1\|499:332	The proportions of HTTP status codes.
Bps	Float	21060178715.146667	The bandwidth. Unit: bit/s.
DomainName	String	example.com	The domain name.

Examples

Sample requests

http://cdn.aliyuncs.com?Action=DescribeDomainDetailDataByLayer
&DomainName=example.com
&Filed=bps,qps,traf,acc,ipv6_traf,ipv6_bps,ipv6_acc,ipv6_qps,http_code
&StartTime=2020-07-05T22:00:00Z
&EndTime=2020-07-05T22:05:00Z
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDomainDetailDataByLayerResponse>
<Data>
    <Acc>2</Acc>
    <Ipv6Bps>0</Ipv6Bps>
    <HttpCode>200:2</HttpCode>
    <Ipv6Qps>0</Ipv6Qps>
    <Bps>268.8986666666667</Bps>
    <Traf>10083</Traf>
    <Ipv6Acc>0</Ipv6Acc>
    <DomainName>example.com</DomainName>
    <Qps>0.006666666666666667</Qps>
    <Ipv6Traf>0</Ipv6Traf>
    <TimeStamp>2020-09-07T03:35:00Z</TimeStamp>
</Data>
<RequestId>BEA5625F-8FCF-48F4-851B-CA63946DA664</RequestId>
</DescribeDomainDetailDataByLayerResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : [ {
    "Acc" : 2,
    "Ipv6Bps" : 0,
    "HttpCode" : "200:2",
    "Ipv6Qps" : 0,
    "Bps" : 268.8986666666667,
    "Traf" : 10083,
    "Ipv6Acc" : 0,
    "DomainName" : "example.com",
    "Qps" : 0.006666666666666667,
    "Ipv6Traf" : 0,
    "TimeStamp" : "2020-09-07T03:35:00Z"
  } ],
  "RequestId" : "BEA5625F-8FCF-48F4-851B-CA63946DA664"
}

Error codes


HttpCode	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified start time is malformed.	The error message returned because the format of the specified start time is invalid. For more information about the time format, see the Request parameters section.
400	InvalidEndTime.Malformed	Specified end time is malformed.	The error message returned because the format of the specified end time is invalid.

For a list of error codes, visit the API Error Center.