DescribeDcdnDomainBpsDataByLayer - Edge Security Acceleration

Operation description

The call frequency for a single user is limited to 20 calls per second.
If you do not specify the StartTime and EndTime parameters, data in the last 24 hours is queried. If you specify the StartTime and EndTime parameters, data in the specified time range is queried.

Supported time granularities

The time granularity that you can specify for the Interval parameter depends on the maximum time range per query. The following table describes the supported time granularities, queryable time ranges, and data latency.

Time granularity	Maximum time range per query	Queryable time 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 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:DescribeDcdnDomainBpsDataByLayer

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name to query. You can specify up to 500 domain names. Separate multiple domain names with commas (,). If you specify multiple domain names, the data is aggregated. If you do not specify this parameter, aggregated data for all your accelerated domain names is returned.	example.com
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 format as yyyy-MM-ddTHH:mm:ssZ. The time must be in UTC. The minimum time granularity is 5 minutes. If you do not specify this parameter, data in the last 24 hours is queried.	2015-12-10T20:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 format as yyyy-MM-ddTHH:mm:ssZ. 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 to query data. Unit: seconds. Valid values are 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). The supported time granularity depends on the maximum time range per query. For more information, see Usage notes.	300
IspNameEn	string	No	The name of the carrier. Call the DescribeDcdnRegionAndIsp operation to query carriers. If you do not specify this parameter, data for all carriers is returned.	telecom
LocationNameEn	string	No	The name of the region. Call the DescribeDcdnRegionAndIsp operation to query regions. If you do not specify this parameter, data for all regions is returned.	hangzhou
Layer	string	No	The dimension to query. Valid values: network layer (IPv4 or IPv6), application layer (http, https, or quic), or all. Default value: all.	all

Response elements

Element	Type	Description	Example
	object
DataInterval	string	The time interval between data entries. Unit: seconds.	300
RequestId	string	The request ID.	BEA5625F-8FCF-48F4-851B-CA63946DA664
BpsDataInterval	object
DataModule	array<object>	The bandwidth data for each time interval.
	object
Value	string	The total bandwidth. Unit: bit/s.	0.56
TrafficValue	string	The total traffic. Unit: bytes.	331
TimeStamp	string	The beginning of the time slice.	2015-12-10T21:00:00Z
DynamicValue	string	The total dynamic bandwidth. Unit: bit/s.	0.34
StaticValue	string	The total static bandwidth. Unit: bit/s.	0.22
DynamicTrafficValue	string	The total dynamic traffic. Unit: bytes.	200
StaticTrafficValue	string	The total static traffic. 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.