DescribeElasticQpsRecord - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the burstable QPS details 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:DescribeElasticQpsRecord

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	integer	Yes	The beginning of the time range to query. The value is a timestamp. Unit: milliseconds.	1684252800000
EndTime	integer	Yes	The end of the time range to query. The value is a timestamp. Unit: milliseconds.	1688140799999
Ip	string	Yes	The IP address of the Anti-DDoS Proxy instance to query.	203.107.XX.XX

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which is used to locate and troubleshoot issues.	F68B34E2-570C-508D-95FD-DFB6611D518F
ElasticQpsList	array<object>	The QPS information about the instance.
	object
OpsElasticQps	integer	The burstable QPS value. A value of 0 indicates that the burstable QPS feature is not enabled.	300000
Ip	string	The IP address of the Anti-DDoS Proxy instance.	203.*.*.199
OriginQps	integer	The service QPS (purchased).	1345
Date	integer	The timestamp. Unit: milliseconds.	1688140799999
InstanceId	string	The ID of the Anti-DDoS Proxy instance.	ddoscoo-cn-7e225i41****
Qps	integer	The daily peak 95th percentile QPS.	4367
QpsPeak	integer	The daily peak traffic.	122
Status	integer	Indicates whether the instance has expired or is released. Valid values: 1: The instance runs as expected. 2: The instance has expired. 4: The instance is released.	1
OpsQps	integer	The service QPS (active).	1345

Examples

Success response

JSON format

{
  "RequestId": "F68B34E2-570C-508D-95FD-DFB6611D518F",
  "ElasticQpsList": [
    {
      "OpsElasticQps": 300000,
      "Ip": "203.***.***.199",
      "OriginQps": 1345,
      "Date": 1688140799999,
      "InstanceId": "ddoscoo-cn-7e225i41****\n",
      "Qps": 4367,
      "QpsPeak": 122,
      "Status": 1,
      "OpsQps": 1345
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.