DescribeDomainDetailDataByLayer - CDN - Alibaba Cloud Documentation Center

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.

Operation description

You can call this operation up to 20 times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Field	string	Yes	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.	bps,ipv6_traf,traf,http_code,qps
DomainName	string	Yes	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.	example.com
StartTime	string	Yes	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.	2020-07-05T22:00:00Z
EndTime	string	Yes	The protocol by which you want to query data. Valid values: http, https, quic, and all. The default value is all.	2020-07-05T22:05:00Z
IspNameEn	string	No	The ID of the request.	telecom
LocationNameEn	string	No	The detailed data of the accelerated domain names.	hangzhou
Layer	string	No	The amount of network traffic. Unit: bytes.	all

Response parameters

Parameter

Type

Description

Example

object

RequestId

string

The number of queries per second.

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

Data

array<object>

The number of IPv6 requests per second.

object

Traf

long

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

789756701818

Qps

float

The number of requests.

5998.47

Ipv6Qps

float

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

Ipv6Bps

float

The number of IPv6 requests.

Acc

long

The timestamp of the data returned.

Ipv6Traf

long

The proportions of HTTP status codes.

141718944482

Ipv6Acc

long

The bandwidth. Unit: bit/s.

TimeStamp

string

The domain name.

2020-07-05T22:00:00Z

HttpCode

string

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

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

Bps

float

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

21060178715.146667

DomainName

string

The number of requests.

example.com

Examples

Sample success responses

JSONformat

{
  "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.	The specified start time is invalid. For more information, see the help documentation of this operation.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.	The specified EndTime parameter is invalid.
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.	The start time is invalid. Set this parameter to another value and try again.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-06-13	The Error code has changed	View Change Details