All Products
Search
Document Center

Anti-DDoS:DescribeInstanceIds

Last Updated:Jan 29, 2023

Queries the ID, version, description, and IP address type of an Anti-DDoS Pro or Anti-DDoS Premium instance.

Operation Description

You can call this 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.

Limit

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.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
yundun-ddoscoo:DescribeInstanceIdsRead
  • DdosCoo
    acs:yundun-ddoscoo:{#regionId}:{#accountId}:*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

The ID of the resource group to which the instance belongs in Resource Management.

If you do not configure this parameter, the instance belongs to the default resource group.

rg-acfm2pz25js****
EditionintegerNo

The type of the instance that you want to query. Valid values:

  • 0: Anti-DDoS Premium instance of the Insurance mitigation plan
  • 1: Anti-DDoS Premium instance of the Unlimited mitigation plan
  • 2: Anti-DDoS Premium instance of the Chinese Mainland Acceleration (CMA) mitigation plan
  • 9: Anti-DDoS Pro instance of the Profession mitigation plan
9
InstanceIdsarrayNo

The IDs of instances that you want to query.

stringNo

The ID of the instance that you want to query.

If you do not configure this parameter, all instances are queried.

ddoscoo-cn-zvp2eibz****

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

310A41FD-0990-5610-92E0-A6A55D7C6444
InstanceIdsarray

An array that consists of the ID, version, description, and IP address type of the instance.

object
IpModestring

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
Editioninteger

The mitigation plan of the instance. Valid values:

  • 0: Anti-DDoS Premium instance of the Insurance mitigation plan
  • 1: Anti-DDoS Premium instance of the Unlimited mitigation plan
  • 2: Anti-DDoS Premium instance of the Chinese Mainland Acceleration (CMA) mitigation plan
  • 3: Anti-DDoS Premium instance of the Secure Chinese Mainland Acceleration (Sec-CMA) mitigation plan
  • 9: Anti-DDoS Pro instance of the Profession mitigation plan
9
InstanceIdstring

The ID of the instance.

ddoscoo-cn-zvp2eibz****
IpVersionstring

The IP version of the protocol of the instance. Valid values:

  • Ipv4
  • Ipv6
Ipv4
Remarkstring

The description of the instance.

test

Example

Normal return example

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 API error center.