Query bandwidth data at a specified time using DescribeDomainBpsDataByTimeStamp - CDN

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.
Each account can call this operation up to 20 times per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:DescribeDomainBpsDataByTimeStamp

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

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 elements

Element	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	object
BpsDataModel	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	integer	The bandwidth value.	52119553

Examples

Success response

JSON format

{
  "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 response

JSON format

{"RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8","HostId":"cdn.aliyuncs.com","Code":"InternalError","Message":"The request processing has failed due to some unknown error."}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	StartTime must be earlier than EndTime.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.