DescribeDomainBpsDataByLayer - CDN - Alibaba Cloud Documentation Center

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 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 day	366 days	366 days	04:00 on the next day

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cdn:DescribeDomainBpsDataByLayer	none	Domain acs:cdn:*:{#accountId}:domain/{#DomainName}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. You can specify up to 500 domain names in each request. Separate multiple domain names with commas (,). Note If 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
StartTime	string	No	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
EndTime	string	No	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.	2020-05-06T07:20:00Z
Interval	string	No	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
IspNameEn	string	No	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
LocationNameEn	string	No	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
Layer	string	No	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

Parameter	Type	Description	Example
	object
DataInterval	string	The time interval between the data entries. Unit: seconds.	300
RequestId	string	The ID of the request.	C565B910-BC3B-467B-9046-2A48566EA967
BpsDataInterval	array<object>	The data returned at each time interval.
	object
Value	string	The peak bandwidth value. Unit: bit/s.	75.68
TrafficValue	string	The total amount of network traffic. Unit: bytes.	2838
TimeStamp	string	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 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.

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

Change history

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