DescribeDomainBps - Anti-DDoS - Alibaba Cloud Documentation Center

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

yundun-ddoscoo:DescribeDomainBps

list

*All Resource

*

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	integer	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	integer	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	integer	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 elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.