DescribeDcdnDomainOriginBpsData - Edge Security Acceleration

Queries the back-to-origin bandwidth monitoring data for a domain name.

Operation description

A single user can call this operation up to 100 times per second.
If you do not specify StartTime and EndTime, data from the last 24 hours is returned by default. If you specify StartTime and EndTime, data in the specified time range is returned.

Supported time granularities

The supported time granularity depends on the maximum time range of a single query. The following table describes the supported time granularities, queryable time ranges for historical data, and data latency.

Time granularity	Maximum time range for a single query	Queryable time range for historical data	Data latency
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	Typically 3 to 4 hours
1 day	366 days	366 days	Typically 4 hours, with a maximum of 24 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

dcdn:DescribeDcdnDomainOriginBpsData

get

domain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. Separate multiple domain names with commas (,). If you leave this parameter empty, data for all your accelerated domain names 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.	2019-12-10T00: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-11T00:00:00Z
Interval	string	No	The time granularity of the data to query, in seconds. Valid values are 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). The supported time granularity varies based on the time range of the query. For more information, see the "Usage notes" section.	300

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range.	2019-12-11T00:00:00Z
StartTime	string	The beginning of the time range.	2019-12-10T00:00:00Z
RequestId	string	The ID of the request.	7CBCD6AD-B016-42E5-AE0B-B3731DE8F755
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between data entries, in seconds.	300
OriginBpsDataPerInterval	object
DataModule	array<object>	The back-to-origin bandwidth at each time interval. Unit: bit/s.
	object
DynamicHttpOriginBps	number	The back-to-origin bandwidth for dynamic HTTP requests.	100
StaticHttpOriginBps	number	The back-to-origin bandwidth for static HTTP requests.	100
TimeStamp	string	The timestamp of the data point.	2019-12-10T00:00:00Z
StaticHttpsOriginBps	number	The back-to-origin bandwidth for static HTTPS requests.	100
OriginBps	number	The back-to-origin bandwidth.	100
DynamicHttpsOriginBps	number	The back-to-origin bandwidth for dynamic HTTPS requests.	100

Examples

Success response

JSON format

{
  "EndTime": "2019-12-11T00:00:00Z",
  "StartTime": "2019-12-10T00:00:00Z",
  "RequestId": "7CBCD6AD-B016-42E5-AE0B-B3731DE8F755",
  "DomainName": "example.com",
  "DataInterval": "300",
  "OriginBpsDataPerInterval": {
    "DataModule": [
      {
        "DynamicHttpOriginBps": 100,
        "StaticHttpOriginBps": 100,
        "TimeStamp": "2019-12-10T00:00:00Z",
        "StaticHttpsOriginBps": 100,
        "OriginBps": 100,
        "DynamicHttpsOriginBps": 100
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidStartTime.Malformed	The specified StartTime parameter is invalid.	The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.