DescribeDomainBpsDataByLayer - Alibaba Cloud CDN - Alibaba Cloud Documentation Center

Queries bandwidth data by protocol.

Operation Description

The number of times that each user can call this operation per second is 20.
If you do not set StartTime or EndTime, data collected within the last 24 hours is queried. If you set both StartTime and EndTime, data collected within the specified time range is queried.

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 time range to query, as described in the following table.

Time granularity	Time range to 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

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.

Operate	access level	Resource type	conditional keyword	Association operation
cdn:DescribeDomainBpsDataByLayer	READ	CDN acs:cdn:*:{#accountId}:domain/{#DomainName}	without	without

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	You can specify multiple domain names and separate them with commas (,). You can specify at most 500 domain names in each call. NoteIf you do not specify an accelerated domain name, the bandwidth data of all the 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. NoteThe end time must be later than the start time.	2020-05-06T07:20:00Z
Interval	string	No	The time interval between the data entries. Unit: seconds. The time granularity varies with the time range to query. Supported 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 the most recent ISP list. 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 the most recent region list. If you do not specify a region, data in all regions is queried.	beijing
Layer	string	No	The layers 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	The number of bytes per second collected 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 data returned.	2020-05-06T07:10:00Z

Example

Normal return example

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 code	Error code	Error message	Description
400	MissingTimeParameter	StartTime and EndTime can not be single.	-
400	InvalidStartTime.Malformed	Specified start time is malformed.
400	InvalidEndTime.Malformed	Specified end time is malformed.	The specified end time is invalid.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time cannot be earlier than the start time
400	InvalidStartTime.ValueNotSupported	Specified end time does not math the specified start time.	-

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