DescribeInstanceIds - Anti-DDoS - Alibaba Cloud Documentation Center

The description of the instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribeInstanceIds	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Edition	integer	No	The type of the instance to query. Valid values: 0: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Insurance mitigation plan 1: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Unlimited mitigation plan 2: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Chinese Mainland Acceleration (CMA) mitigation plan 3: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Secure Chinese Mainland Acceleration (Sec-CMA) mitigation plan 9: Anti-DDoS Proxy (Chinese Mainland) instance of the Profession mitigation plan	9
InstanceIds	array	No	The IDs of instances to query.
	string	No	The ID of the instance to query. If you do not configure this parameter, all instances are queried.	ddoscoo-cn-zvp2eibz****

Response parameters

Parameter	Type	Description	Example
	object
InstanceIds	array<object>	The ID, type, description, and IP version of the instance.
Instance	object
IpMode	string	The IP address-based forwarding mode of the instance. Valid values: fnat: Requests from IPv4 addresses are forwarded to origin servers that use IPv4 addresses and requests from IPv6 addresses are forwarded to origin servers that use IPv6 addresses. v6tov4: All requests are forwarded to origin servers that use IPv4 addresses.	fnat
Edition	integer	The type of the instance. Valid values: 0: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Insurance mitigation plan 1: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Unlimited mitigation plan 2: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the CMA mitigation plan 3: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Sec-CMA mitigation plan 9: Anti-DDoS Proxy (Chinese Mainland) instance of the Profession mitigation plan	9
InstanceId	string	The ID of the instance.	ddoscoo-cn-zvp2eibz****
IpVersion	string	The IP version of the instance. Valid values: Ipv4 Ipv6	Ipv4
Remark	string	The description of the instance.	test

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.