DescribeDomainBpsDataByTimeStamp - CDN - Alibaba Cloud Documentation Center

Queries the bandwidth data at a specified time for an accelerated domain.

Operation description

The bandwidth is measured in bit/s.
You can specify only one accelerated domain name in each request.
The data is collected every 5 minutes.
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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can specify only one domain name in each request.	example.com
TimePoint	string	Yes	The point in time 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 data is collected every 5 minutes.	2019-11-30T05:40:00Z
IspNames	string	Yes	The names of the Internet service providers (ISPs). Separate multiple ISPs with commas (,). You can call the DescribeCdnRegionAndIsp operation to query regions.	uni*,tele*
LocationNames	string	Yes	The regions. Separate multiple regions with commas (,). You can call the DescribeCdnRegionAndIsp operation to query regions.	liaoning,guangxi

Response parameters

Parameter	Type	Description	Example
	object
TimeStamp	string	The point in time.	2019-11-30T05:40:00Z
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
DomainName	string	The accelerated domain name.	example.com
BpsDataList	array<object>	A list of bandwidth values by ISP and region.
	object
LocationName	string	The name of the region.	Liaoning
TimeStamp	string	The timestamp of the data returned.	2019-11-30T05:40:00Z
IspName	string	The name of the ISP.	unicom
Bps	long	The bandwidth value.	52119553

Examples

Sample success responses

JSONformat

{
  "TimeStamp": "2019-11-30T05:40:00Z",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "DomainName": "example.com",
  "BpsDataList": {
    "BpsDataModel": [
      {
        "LocationName": "Liaoning",
        "TimeStamp": "2019-11-30T05:40:00Z",
        "IspName": "unicom",
        "Bps": 52119553
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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	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.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	StartTime must be earlier than EndTime.

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

Change history

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