DescribeInstances

Retrieves a list of Anti-DDoS Proxy instances.

Operation description

Use this operation to retrieve paginated details for Anti-DDoS instances in your Alibaba Cloud account. The response includes the instance ID, version, expiration time, and service traffic forwarding status.

QPS limit

This operation is limited to 10 calls per second per user. Exceeding this limit triggers throttling, which can disrupt your services.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the Anti-DDoS Proxy instance belongs in Resource Management. If you omit this parameter, the system uses the default resource group.	rg-acfm2pz25js****
PageNumber	string	Yes	The number of the page to return. Pages start from 1.	1
PageSize	string	Yes	The number of instances to return per page. Valid values: 1 to 50.	10
Ip	string	No	The IP address of the Anti-DDoS Proxy instance.	203.107.XX.XX
Remark	string	No	The remark of the Anti-DDoS Proxy instance. Fuzzy matching is supported.	doc-test
Edition	integer	No	The edition of the Anti-DDoS Proxy instance. Valid values: 0: Anti-DDoS Proxy (Outside Chinese Mainland) Insurance. 1: Anti-DDoS Proxy (Outside Chinese Mainland) Unlimited. 2: Anti-DDoS Proxy (Outside Chinese Mainland) CMA. 9: Anti-DDoS Proxy (Chinese Mainland) Professional Edition.	9
Enabled	integer	No	The service traffic forwarding status of the Anti-DDoS Proxy instance. Valid values: 0: Traffic forwarding is stopped. 1: Traffic is forwarded.	1
ExpireStartTime	integer	No	The start of the expiration time range to query. The operation returns only instances that expire after this time. The value is a Unix timestamp in milliseconds.	1640361500000
ExpireEndTime	integer	No	The end of the expiration time range to query. The operation returns only instances that expire on or before this time. The value is a Unix timestamp in milliseconds.	1640361700000
InstanceIds	array	No	An array of Anti-DDoS Proxy instance IDs. You can specify up to 200 instance IDs.
	string	No	The ID of an Anti-DDoS Proxy instance.	ddoscoo-cn-7pp2g9ed****
Status	array	No	An array of instance statuses for filtering. You can specify up to two statuses.
	integer	No	The status of the Anti-DDoS Proxy instance. Valid values: 1: Normal. 2: Expired.	1
Tag	array<object>	No	An array of tags for filtering instances.
	object	No
Key	string	No	The tag key used for filtering. You can specify up to 200 tags. A tag is a key-value pair defined by a tag key (Key) and a tag value (Value). You can use tags to filter instances. Note The Key and Value parameters for a tag must be specified as a pair.	test-key
Value	string	No	The tag value used for filtering. You can specify up to 200 tags. A tag is a key-value pair defined by a tag key (Key) and a tag value (Value). You can use tags to filter instances. Note The Key and Value parameters for a tag must be specified as a pair.	test-value

When you call this API, you must include both the API-specific request parameters and the Alibaba Cloud common request parameters. For more information, see Common parameters.

For the request format, see the sample request in the Examples section.

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of instances found.	1
RequestId	string	The request ID. Alibaba Cloud generates this unique ID for the request. Use it to locate and troubleshoot issues.	A0AF40CC-814A-5A86-AEAA-6F19E88B8A39
Instances	array<object>	A list of instance details.
	object
Status	integer	The status of the instance. Valid values: 1: Normal 2: Expired	1
IpMode	string	The IP forwarding mode of the instance. Valid values: fnat: The IP versions of the client and the origin server are the same. For example, requests from IPv4 clients are forwarded to IPv4 origin servers, and requests from IPv6 clients are forwarded to IPv6 origin servers. v6tov4: Requests from IPv6 clients are forwarded to IPv4 origin servers.	fnat
DebtStatus	integer	The overdue payment status of the instance. The value is fixed at 0, which indicates no overdue payment. This is because both Anti-DDoS Pro (Chinese Mainland) and Anti-DDoS Proxy (Outside Chinese Mainland) are subscription-based.	0
Edition	integer	The edition of the instance. Valid values: 0: Anti-DDoS Proxy (Outside Chinese Mainland) Insurance 1: Anti-DDoS Proxy (Outside Chinese Mainland) Unlimited 2: Anti-DDoS Proxy (Outside Chinese Mainland) CMA 9: Anti-DDoS Pro (Chinese Mainland) Professional Edition	9
IpVersion	string	The IP protocol version of the instance. Valid values: Ipv4: IPv4 Ipv6: IPv6	Ipv4
ExpireTime	integer	The expiration time of the instance, provided as a UNIX timestamp in milliseconds.	1640361600000
Remark	string	The remark for the instance.	doc-test
CreateTime	integer	The creation time of the instance, provided as a UNIX timestamp in milliseconds.	1637751953000
Enabled	integer	The service traffic forwarding status of the instance. Valid values: 0: Service traffic forwarding is stopped. 1: Service traffic forwarding is active.	1
InstanceId	string	The ID of the instance.	ddoscoo-cn-7pp2g9ed****
IsFirstOpenBw	integer	Specifies whether the 95th percentile burstable clean bandwidth billing method has been previously enabled. Valid values: 0: No 1: Indicates that it has been enabled.	0
IsFirstOpenQps	integer	Specifies whether the 95th percentile burstable QPS billing method has been previously enabled. Valid values: 0: No 1: Enabled.	0
Ip	string	The IP address of the instance.	203.199.XX.XX

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "A0AF40CC-814A-5A86-AEAA-6F19E88B8A39",
  "Instances": [
    {
      "Status": 1,
      "IpMode": "fnat",
      "DebtStatus": 0,
      "Edition": 9,
      "IpVersion": "Ipv4",
      "ExpireTime": 1640361600000,
      "Remark": "doc-test",
      "CreateTime": 1637751953000,
      "Enabled": 1,
      "InstanceId": "ddoscoo-cn-7pp2g9ed****",
      "IsFirstOpenBw": 0,
      "IsFirstOpenQps": 0,
      "Ip": "203.199.XX.XX"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.