All Products
Search
Document Center

Alibaba Cloud CDN:DescribeDomainDetailDataByLayer

Last Updated:Jan 30, 2023

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

Operation 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 granularityMaximum time range per queryHistorical data availableData delay
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours
1 days366 days366 days04:00 on the next day

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
cdn:DescribeDomainDetailDataByLayerRead
  • CDN
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
FieldstringYes

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.

bps,ipv6_traf,traf,http_code,qps
DomainNamestringYes

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.

example.com
StartTimestringYes

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.

2020-07-05T22:00:00Z
EndTimestringYes

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.

NoteThe end time must be later than the start time.
2020-07-05T22:05:00Z
IspNameEnstringNo

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.

telecom
LocationNameEnstringNo

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.

hangzhou
LayerstringNo

The protocol by which you want to query data. Valid values: http, https, quic, and all.

The default value is all.

all

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The detailed data of the accelerated domain names.

object
Traflong

The amount of network traffic. Unit: bytes.

789756701818
Qpsnumber

The number of queries per second.

5998.47
Ipv6Qpsnumber

The number of IPv6 requests per second.

0
Ipv6Bpsnumber

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

0
Acclong

The number of requests.

2
Ipv6Traflong

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

141718944482
Ipv6Acclong

The number of IPv6 requests.

1
TimeStampstring

The timestamp of the data returned.

2020-07-05T22:00:00Z
HttpCodestring

The proportions of HTTP status codes.

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

The bandwidth. Unit: bit/s.

21060178715.146667
DomainNamestring

The domain name.

example.com

Example

Normal return example

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 codeError codeError messageDescription
400MissingTimeParameterStartTime and EndTime can not be single.-
400InvalidStartTime.MalformedSpecified start time is malformed.
400InvalidEndTime.MalformedSpecified end time is malformed.The specified end time is invalid.
400InvalidEndTime.MismatchSpecified end time does not match the specified start time.-
400InvalidStartTime.ValueNotSupportedSpecified end time does not match the specified start time.-
400InvalidDomainName.MalformedSpecified domain name is malformed.-

For a list of error codes, visit the API error center.