Queries the information about Anti-DDoS Pro or Anti-DDoS Premium instances, such as the ID, version, description, and IP address type.
Usage notes
You can call the DescribeInstanceIds operation to query the information about all Anti-DDoS Pro or Anti-DDoS Premium instances, such as the ID, version, description, and IP address type.
Limits
You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeInstanceIds |
The operation that you want to perform. Set the value to DescribeInstanceIds. |
RegionId | String | No | cn-hangzhou |
The region ID of the instance. Valid values:
|
ResourceGroupId | String | No | rg-acfm2pz25js**** |
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 configure this parameter, the Anti-DDoS Pro or Anti-DDoS Premium instance belongs to the default resource group. |
Edition | Integer | No | 9 |
The type of the instance to query. Valid values:
|
InstanceIds.N | String | No | ddoscoo-cn-zvp2eibz**** |
The ID of the instance to query. If you do not configure this parameter, all instances are queried. |
All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.
For more information about sample requests, see the "Examples" section of this topic.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 310A41FD-0990-5610-92E0-A6A55D7C6444 |
The ID of the request. |
InstanceIds | Array of Instance |
The ID, version, description, and IP address type of the instance. |
|
IpMode | String | fnat |
The IP address-based forwarding mode of the instance. Valid values:
|
Edition | Integer | 9 |
The mitigation plan of the instance. Valid values:
|
InstanceId | String | ddoscoo-cn-zvp2eibz**** |
The ID of the instance. |
IpVersion | String | Ipv4 |
The IP version of the protocol of the instance. Valid values:
|
Remark | String | test |
The description of the instance. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeInstanceIds
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeInstanceIdsResponse>
<RequestId>310A41FD-0990-5610-92E0-A6A55D7C6444</RequestId>
<InstanceIds>
<IpMode>fnat</IpMode>
<Edition>9</Edition>
<InstanceId>ddoscoo-cn-zvp2eibz****</InstanceId>
<IpVersion>Ipv4</IpVersion>
<Remark>test</Remark>
</InstanceIds>
</DescribeInstanceIdsResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"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 API Error Center.