DescribeElasticQps - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the line chart of the bills for the burstable QPS of an Anti-DDoS Proxy instance.

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:DescribeElasticQps

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The type of the service. Valid values: cn: Anti-DDoS Proxy (Chinese Mainland) cn-hongkong: Anti-DDoS Proxy (Outside Chinese Mainland)	cn
Ip	string	No	The IP address of the Anti-DDoS Proxy instance to query.	203.107.XX.XX
StartTime	integer	Yes	The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1684252800
EndTime	integer	Yes	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1684339200
Interval	string	No	The sampling interval. Unit: seconds. The value must be a multiple of 60. Default value: 60. Unit: seconds. The query result varies depending on the sampling interval.	60

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which is used to locate and troubleshoot issues.	2E7F7F7B-39A8-5D92-BAB4-D89D9DCE7D4F
ElasticQps	array<object>	The information about the burstable QPS.
	object
MaxNormalQps	integer	The peak QPS of the normal service.	23
Index	integer	The index number of the returned data.	1
MaxQps	integer	The peak inbound QPS.	100
Pv	integer	The total number of requests during the step size period.	15104
Ups	integer	The total number of origin requests during the step size period.	1223
Status2	integer	The total number of HTTP 2xx status codes during the step size period.	455
Status3	integer	The total number of HTTP 3xx status codes during the step size period.	100
Status4	integer	The total number of HTTP 4xx status codes during the step size period.	34
Status5	integer	The total number of HTTP 5xx status codes during the step size period.	0

Examples

Success response

JSON format

{
  "RequestId": "2E7F7F7B-39A8-5D92-BAB4-D89D9DCE7D4F",
  "ElasticQps": [
    {
      "MaxNormalQps": 23,
      "Index": 1,
      "MaxQps": 100,
      "Pv": 15104,
      "Ups": 1223,
      "Status2": 455,
      "Status3": 100,
      "Status4": 34,
      "Status5": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.