Use DescribeDomainSrcBpsData to query origin bandwidth data - CDN

Operation description

Each account can call this operation up to 100 times per second.
If you do not specify the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you specify both the StartTime and EndTime 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 time range to 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

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

none

*Domain

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

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 call. Separate multiple domain names with commas (,). By default, this operation queries the geographic distribution of users for all accelerated domain names.	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.	2019-12-10T20:00: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-12-10T20:30:00Z
Interval	string	No	The time interval between 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 Description.	300

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2019-12-10T20:30:00Z
StartTime	string	The start of the time range during which data was queried.	2019-12-10T20:00:00Z
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	300
SrcBpsDataPerInterval	object
DataModule	array<object>	The origin bandwidth data at each time interval. Unit: bit/s.
	object
Value	string	The traffic value at each time interval.	500
TimeStamp	string	The timestamp of the returned data.	2019-12-10T20:00:00Z
HttpsValue	string	The bandwidth values of origin HTTPS requests.	10

Examples

Success response

JSON format

{
  "EndTime": "2019-12-10T20:30:00Z",
  "StartTime": "2019-12-10T20:00:00Z",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "DomainName": "example.com",
  "DataInterval": "300",
  "SrcBpsDataPerInterval": {
    "DataModule": [
      {
        "Value": "500",
        "TimeStamp": "2019-12-10T20:00:00Z",
        "HttpsValue": "10"
      }
    ]
  }
}

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	MissingParameter	StartTime and EndTime can not be single.
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.
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.
400	InvalidDomainName.Overlimit	Too many DomainNames are specified.	The number of specified domain names exceeds the limit of the operation.
400	InvalidInterval.Malformed	Specified Interval is malformed.	The format of the time granularity is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.