DescribeDomainBps - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the bandwidths of a website.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribeDomainBps	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The region in which your service is deployed. Valid values: cn: a region in the Chinese mainland. cn-hongkong: a region outside the Chinese mainland.	cn
Domain	string	No	The domain name of the website. Note A forwarding rule must be configured for the domain name. You can call the DescribeDomains operation to query all domain names.	www.example.com
StartTime	long	Yes	The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1719211800
EndTime	long	Yes	The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1722339300
Interval	long	Yes	The interval for returning data. Unit: seconds. Valid values are 300, 3600, and 86400. If the time span between StartTime and EndTime is less than 3 days, valid values are 300, 3600, and 86400. If the time span between StartTime and EndTime is from 3 to 30 days, valid values are 3600 and 86400. If the time span between StartTime and EndTime is 31 days or longer, the valid value is 86400. If you leave this parameter empty or specify an invalid value, the default value is used.	600

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E
DomainBps	array<object>	The bandwidths.
DomainBps	object	The bandwidth values.
Index	long	The index number of the returned data.	1
InBps	long	The inbound bandwidth. Unit: bit/s.	0
OutBps	long	The outbound bandwidth. Unit: bit/s.	0

Examples

Sample success responses

JSONformat

{
  "RequestId": "C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E",
  "DomainBps": [
    {
      "Index": 1,
      "InBps": 0,
      "OutBps": 0
    }
  ]
}

Error codes

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