Call DescribeInstanceIds to query instance details - Anti-DDoS - Alibaba Cloud - Anti-DDoS

Operation description

This operation is used to query the IDs, editions, remarks, and IP type information of all Anti-DDoS Pro or Anti-DDoS Premium instances.

QPS limit

You can invoke this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. This may affect your business. Invoke this operation within the limit.

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 ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. If you do not set this parameter, the instance belongs to the default resource group.	rg-acfm2pz25js****
Edition	integer	No	The edition of the Anti-DDoS Pro or Anti-DDoS Premium instance to query. Valid values: 0: Anti-DDoS Premium (outside the Chinese mainland) Insurance mitigation plan. 1: Anti-DDoS Premium (outside the Chinese mainland) Unlimited mitigation plan. 2: Anti-DDoS Premium (outside the Chinese mainland) acceleration line. 3: Anti-DDoS Premium (outside the Chinese mainland) secure acceleration line. 9: Anti-DDoS Pro (the Chinese mainland) Professional edition.	9
InstanceIds	array	No	The IDs of the Anti-DDoS Pro or Anti-DDoS Premium instances to query. Maximum value of N: 200.	ddoscoo-cn-mp91j1ao****
	string	No	The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance to query. If you do not set this parameter, all Anti-DDoS Pro or Anti-DDoS Premium instances are queried.	ddoscoo-cn-zvp2eibz****

When you call this operation, you must include the common request parameters of Alibaba Cloud APIs in addition to the request parameters described in this topic. For more information about common request parameters, see Common parameters.

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	310A41FD-0990-5610-92E0-A6A55D7C6444
InstanceIds	array<object>	The IDs, editions, remarks, and IP type information of the Anti-DDoS Pro or Anti-DDoS Premium instances.
	object
IpMode	string	The IP forwarding mode of the instance. Valid values: fnat: The IP versions of the origin server and the client are the same. IPv4 client requests are forwarded to IPv4 origin servers, and IPv6 client requests are forwarded to IPv6 origin servers. v6tov4: Both IPv6 and IPv4 client requests are forwarded to IPv4 origin servers.	fnat
Edition	integer	The edition of the instance. Valid values: 0: Anti-DDoS Pro and Anti-DDoS Premium (outside the Chinese mainland) Insurance mitigation plan. 1: Anti-DDoS Pro and Anti-DDoS Premium (outside the Chinese mainland) Unlimited mitigation plan. 2: Anti-DDoS Pro and Anti-DDoS Premium (outside the Chinese mainland) acceleration line. 3: Anti-DDoS Pro and Anti-DDoS Premium (outside the Chinese mainland) secure acceleration line. 9: Anti-DDoS Pro and Anti-DDoS Premium (the Chinese mainland) Professional edition.	9
InstanceId	string	The instance ID.	ddoscoo-cn-zvp2eibz****
IpVersion	string	The IP protocol version of the instance. Valid values: Ipv4: IPv4. Ipv6: IPv6.	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.