DescribeInstanceIds - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the IDs, versions, remarks, and IP type information of Anti-DDoS Proxy instances.

Operation description

This operation queries the IDs, versions, remarks, and IP type information of all Anti-DDoS instances.

QPS limits

The maximum number of queries per second (QPS) for a single user is 10. If you exceed this limit, API calls will be throttled, which may affect your business. Please call this operation at a reasonable rate.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The resource group ID of the Anti-DDoS Proxy instance in Resource Management. If this parameter is not specified, the default resource group is used.	rg-acfm2pz25js****
Edition	integer	No	The type of Anti-DDoS Proxy instance to query. 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. 3: Anti-DDoS Proxy (Outside Chinese Mainland) Sec-CMA. 9: Anti-DDoS Proxy (Chinese Mainland) Professional Edition.	9
InstanceIds	array	No	The list of Anti-DDoS Proxy instance IDs to query. The maximum value of N is 200.	ddoscoo-cn-mp91j1ao****
	string	No	The ID of the Anti-DDoS Proxy instance to query. If this parameter is not specified, all Anti-DDoS Proxy instances are queried.	ddoscoo-cn-zvp2eibz****

When you call this operation, in addition to the request parameters described in this topic, you must also specify the common request parameters of Alibaba Cloud API. For more information, see common parameters.

For the request format, see the request example in the Examples section of this topic.

Response elements

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	310A41FD-0990-5610-92E0-A6A55D7C6444
InstanceIds	array<object>	The IDs, versions, remarks, and IP type information of the Anti-DDoS Proxy instances.
	object
IpMode	string	The IP forwarding mode of the instance. Valid values: fnat: The IP version of the origin server is the same as that of the client. This means that requests from IPv4 clients are forwarded to IPv4 origin servers, and requests from IPv6 clients are forwarded to IPv6 origin servers. v6tov4: Requests from both IPv6 and IPv4 clients are forwarded to IPv4 origin servers.	fnat
Edition	integer	The type 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. 3: Anti-DDoS Proxy (Outside Chinese Mainland) Sec-CMA. 9: Anti-DDoS Pro (Chinese Mainland) Professional Edition.	9
InstanceId	string	The ID of the instance.	ddoscoo-cn-zvp2eibz****
IpVersion	string	The IP protocol version of the instance. Valid values: Ipv4: IPv4 version. Ipv6: IPv6 version.	Ipv4
Remark	string	The remark of the instance.	test

Examples

Success response

JSON format

{
  "RequestId": "310A41FD-0990-5610-92E0-A6A55D7C6444",
  "InstanceIds": [
    {
      "IpMode": "fnat",
      "Edition": 9,
      "InstanceId": "ddoscoo-cn-zvp2eibz****",
      "IpVersion": "Ipv4",
      "Remark": "test"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.