DescribeDcdnDomainBpsDataByLayer-阿里云帮助中心

Queries the bandwidth data of accelerated domain names by protocol.

Operation description

Rate limit: 20 calls per second per user.
If you do not specify StartTime and EndTime, the system queries the data of the last 24 hours by default. If you specify StartTime and EndTime, the system queries the data within the specified time range.

Supported time granularity

The request parameter Interval supports different data timestamp granularity based on the maximum time span of a single query. The corresponding time range of historical data that can be queried and data latency are as follows:

Time granularity	Maximum time span per query	Queryable historical data range	Data latency
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	Typically 3 to 4 hours
1 day	90 days	366 days	Typically 4 hours, up to 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:DescribeDcdnDomainBpsDataByLayer

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain names to be queried. You can specify multiple domain names separated by commas (,). A maximum of 500 domain names are supported. The data of multiple domain names is aggregated and returned. If this parameter is left empty, the aggregated data of all accelerated domain names is returned by default.	example.com
StartTime	string	No	The start time of the data to be queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The minimum data granularity is 5 minutes. If this parameter is not specified, the data of the last 24 hours is queried by default.	2015-12-10T20:00:00Z
EndTime	string	No	The end time of the data to be queried. 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.	2015-12-10T21:00:00Z
Interval	string	No	The time granularity of the data to be queried. Unit: seconds. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). The valid values vary based on the maximum time span of a single query. For more information, see the Supported time granularities section in the usage notes.	300
IspNameEn	string	No	The English name of the ISP. You can call the DescribeDcdnRegionAndIsp operation to query ISPs. If you do not specify this parameter, all ISPs are queried.	telecom
LocationNameEn	string	No	The English name of the region. You can call the DescribeDcdnRegionAndIsp operation to query regions. If you do not specify this parameter, all regions are queried.	hangzhou
Layer	string	No	The query dimension. Valid values: network layer (IPv4 and IPv6), application layer (HTTP, HTTPS, and QUIC), and all. Default value: all.	all

Response elements

Element	Type	Description	Example
	object
DataInterval	string	The time interval of each record. Unit: seconds.	300
RequestId	string	The ID of the request.	BEA5625F-8FCF-48F4-851B-CA63946DA664
BpsDataInterval	object
DataModule	array<object>	The bandwidth at each time interval.
	object
Value	string	The total bandwidth.	0.56
TrafficValue	string	The total traffic. Unit: bytes.	331
TimeStamp	string	The start time of the time interval. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2015-12-10T21:00:00Z
DynamicValue	string	The total bandwidth of dynamic content.	0.34
StaticValue	string	The total bandwidth of static content.	0.22
DynamicTrafficValue	string	The total traffic of dynamic content. Unit: bytes.	200
StaticTrafficValue	string	The total traffic of static content. Unit: bytes.	131

Examples

Success response

JSON format

{
  "DataInterval": "300",
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "BpsDataInterval": {
    "DataModule": [
      {
        "Value": "0.56",
        "TrafficValue": "331",
        "TimeStamp": "2015-12-10T21:00:00Z",
        "DynamicValue": "0.34",
        "StaticValue": "0.22",
        "DynamicTrafficValue": "200",
        "StaticTrafficValue": "131"
      }
    ]
  }
}

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 StartTime cannot exceed 31 days before the current time.	You can query data only within the last 31 days.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.