Queries the detailed data of one or more accelerated domain names by protocol. Data is collected by domain name every 5 minutes.

Note
  • If you specify the StartTime and the EndTime parameters, the QPS data within the specified time range is queried. The StartTime and the EndTime parameters must be specified together.
  • You can specify multiple domain names (no more than 30) and separate them with commas (,).
  • You can query data within the last hour.
  • The maximum number of times that each user can call this operation per second is 20.

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.

DomainName String Yes example.com

The domain name for which you want to query data. You can specify multiple domain names and separate them with commas (,). You can specify at most 30 domain names in each call.

Field String Yes bps,ipv6_traf,traf,http_code,qps

The metric from which you want to collect data. You can specify one or more protocols and separate them with commas (,). Valid values: bps, qps, traf, acc, ipv6_traf, ipv6_bps, ipv6_acc, ipv6_qps, and http_code.

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.

Note The minimum time interval between data entries is 5 minutes.
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.
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.

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 the ISP name.

If you do not specify an ISP, the data of all ISPs 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
Data Array of DataModule

The detailed data of the accelerated domain names.

DataModule
Acc Long 2

The number of requests.

Bps Float 21060178715.146667

The bandwidth, in bit/s.

DomainName String example.com

The domain name for which the data is queried.

HttpCode String 200:44349|206:1753719|304:45|403:1095|416:1|499:332

The proportions of HTTP status codes.

Ipv6Acc Long 1

The number of IPv6 requests.

Ipv6Bps Float 0

The bandwidth of IPv6 requests. Unit: bit/s.

Ipv6Qps Float 0

The number of IPv6 requests per second.

Ipv6Traf Long 141718944482

The amount of network traffic generated by IPv6 requests. Unit: bytes.

Qps Float 5998.47

The number of queries per second.

TimeStamp String 2020-07-05T22:00:00Z

The timestamp of the data returned.

Traf Long 789756701818

The amount of network traffic. Unit: bytes.

RequestId String BEA5625F-8FCF-48F4-851B-CA63946DA664

The ID of the request.

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

<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>wenhuajuan.cdn.ialicdn.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

{
    "Data": [
        {
                "Acc": 2,
                "Ipv6Bps": 0,
                "HttpCode": "200:2",
                "Ipv6Qps": 0,
                "Bps": 268.8986666666667,
                "Traf": 10083,
                "Ipv6Acc": 0,
                "DomainName": "wenhuajuan.cdn.ialicdn.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.