All Products
Search
Document Center

CDN:DescribeDomainBpsDataByLayer

Last Updated:May 30, 2023

Queries bandwidth data by protocol.

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 time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the maximum time range per query, as described in the following table.

Time granularityMaximum time range per queryHistorical data availableData delay
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours
1 day366 days366 days04:00 on the next day

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:DescribeDomainBpsDataByLayerREAD
  • CDN
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name. You can specify up to 500 domain names in each request. Separate multiple domain names with commas (,).

NoteIf you do not specify this parameter, the bandwidth data about all accelerated domain names that belong to your Alibaba Cloud account is queried.
example.com
StartTimestringNo

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-05-06T07:10:00Z
EndTimestringNo

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-05-06T07:20:00Z
IntervalstringNo

The time granularity of the data entries. Unit: seconds.

The time granularity varies with the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes.

300
IspNameEnstringNo

The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query ISPs. If you do not specify an ISP, data of all ISPs is queried.

unicom
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.

beijing
LayerstringNo

The layer at which you want to query the bandwidth data. Valid values:

  • Network layer: IPv4 and IPv6.
  • Application layer: http, https, and quic.
  • all: specifies that both the network and application layers are included.

Default value: all.

IPv4

Response parameters

ParameterTypeDescriptionExample
object
DataIntervalstring

The time interval between the data entries. Unit: seconds.

300
RequestIdstring

The ID of the request.

C565B910-BC3B-467B-9046-2A48566EA967
BpsDataIntervalobject []

The data returned at each time interval.

Valuestring

The peak bandwidth value. Unit: bit/s.

75.68
TrafficValuestring

The total amount of network traffic. Unit: bytes.

2838
TimeStampstring

The timestamp of the returned data.

2020-05-06T07:10:00Z

Examples

Sample success responses

JSONformat

{
  "DataInterval": "300",
  "RequestId": "C565B910-BC3B-467B-9046-2A48566EA967",
  "BpsDataInterval": {
    "DataModule": [
      {
        "Value": "75.68",
        "TrafficValue": "2838",
        "TimeStamp": "2020-05-06T07:10:00Z"
      }
    ]
  }
}

Error codes

HTTP status 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 math the specified start time.The end time cannot be earlier than the start time
400InvalidStartTime.ValueNotSupportedSpecified end time does not math the specified start time.-

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