Use DescribeDomainRealTimeBpsData to query real-time bandwidth data - CDN

Operation description

Each account can call this operation up to 100 times per second.
If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last hour. If you set both these parameters, the request returns the data collected within the specified time range.

Time granularity The time granularity varies with the time range specified by the StartTime and EndTime parameters. The following table describes the time period within which historical data is available and the data delay.

Time granularity	Maximum time range per query	Historical data available	Data delay
1 minute	1 hour	7 days	5 minutes
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	4 hours

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:DescribeDomainRealTimeBpsData

none

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. Separate multiple accelerated domain names with commas (,). Note You can specify up to 500 domain names in each request.	example.com
IspNameEn	string	No	The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query ISPs. If you do not set this parameter, all ISPs are queried.	telecom
LocationNameEn	string	No	The name of the region. You can call the DescribeCdnRegionAndIsp operation to query regions. If you do not set this parameter, all regions are queried.	beijing
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.	2019-11-30T05:33: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.	2019-11-30T05:40:00Z

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	B49E6DDA-F413-422B-B58E-2FA23F286726
Data	object
BpsModel	array<object>	The data returned.
	object
Bps	number	The bandwidth. Unit: bit/s.	16710625.733333332
TimeStamp	string	The timestamp of the data returned. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-11-30T05:41:00Z

Examples

Success response

JSON format

{
  "RequestId": "B49E6DDA-F413-422B-B58E-2FA23F286726",
  "Data": {
    "BpsModel": [
      {
        "Bps": 16710625.733333332,
        "TimeStamp": "2019-11-30T05:41:00Z"
      }
    ]
  }
}

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	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	The specified start or end time is invalid.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.	The specified domain name is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.