DescribeDcdnDomainBpsDataByLayer - Edge Security Acceleration

Queries bandwidth data of accelerated domain names.

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. Separate mutiple domain names with commas (,). You can specify up to 500 domain names in each request. The query results of multiple domain names are aggregated. If you do not specify a domain name, data of all 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. The minimum data granularity is 5 minutes. If you do not set 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 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 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 Usage notes.	300
IspNameEn	string	No	The Internet service provider (ISP) name. You can call the DescribeDcdnRegionAndIsp operation to query the ISP name. If you do not specify this parameter, all ISPs are queried.	telecom
LocationNameEn	string	No	The region name. 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 layer at which you want to query the bandwidth data. The network layer supports IPv4 and IPv6. The application layer supports http, https, and quic. You can also set the value to all. Default value: all.	all

Response parameters

Parameter	Type	Description	Example
	object
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	300
RequestId	string	The request ID.	BEA5625F-8FCF-48F4-851B-CA63946DA664
BpsDataInterval	array<object>	The bandwidth returned at each time interval.
DataModule	object
Value	string	The total bandwidth. Unit: bit/s.	0.56
TrafficValue	string	The total traffic. Unit: bytes.	331
TimeStamp	string	The timestamp of the data returned.	2015-12-10T21:00:00Z
DynamicValue	string	The bandwidth that is used to deliver dynamic content. Unit: bit/s.	0.34
StaticValue	string	The bandwidth that is used to deliver static content. Unit: bit/s.	0.22
DynamicTrafficValue	string	The traffic that is used to deliver dynamic content. Unit: bytes.	200
StaticTrafficValue	string	The traffic that is used to deliver static content. Unit: bytes.	131

Examples

Sample success responses

JSONformat

{
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-04-13	The Error code has changed. The response structure of the API has changed	View Change Details