All Products
Search
Document Center

CDN:DescribeDomainDetailDataByLayer

Last Updated:Mar 28, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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 Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
cdn:DescribeDomainDetailDataByLayerRead
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FieldstringYes

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
DomainNamestringYes

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
StartTimestringYes

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
EndTimestringYes

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
IspNameEnstringNo

The ID of the request.

telecom
LocationNameEnstringNo

The detailed data of the accelerated domain names.

hangzhou
LayerstringNo

The amount of network traffic. Unit: bytes.

all

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The number of queries per second.

BEA5625F-8FCF-48F4-851B-CA63946DA664
Dataobject []

The number of IPv6 requests per second.

Traflong

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

789756701818
Qpsfloat

The number of requests.

5998.47
Ipv6Qpsfloat

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

0
Ipv6Bpsfloat

The number of IPv6 requests.

0
Acclong

The timestamp of the data returned.

2
Ipv6Traflong

The proportions of HTTP status codes.

141718944482
Ipv6Acclong

The bandwidth. Unit: bit/s.

1
TimeStampstring

The domain name.

2020-07-05T22:00:00Z
HttpCodestring
  • 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
200:44349|206:1753719|304:45|403:1095|416:1|499:332
Bpsfloat

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

21060178715.146667
DomainNamestring

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 codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe specified value of parameter StartTime is malformed.The specified start time is invalid. For more information, see the help documentation of this operation.
400InvalidEndTime.MalformedThe specified value of parameter EndTime is malformed.The specified EndTime parameter is invalid.
400InvalidEndTime.MismatchSpecified EndTime does not match the specified StartTime.StartTime must be earlier than EndTime.
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The start time is invalid. Set this parameter to another value and try again.
400InvalidDomainName.MalformedThe specified DomainName is invalid.The specified domain name is invalid.

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

Change history

Change timeSummary of changesOperation
2023-06-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change