Queries the details about Anti-DDoS Pro or Anti-DDoS Premium instances.

Usage notes

You can call this operation to query the details about Anti-DDoS Pro or Anti-DDoS Premium instances within the Alibaba Cloud account by page. The details include the ID, mitigation plan, expiration time, and forwarding status.

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstances

The operation that you want to perform. Set the value to DescribeInstances.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: Chinese mainland, which indicates Anti-DDoS Pro instances. This is the default value.
  • ap-southeast-1: outside the Chinese mainland, which indicates Anti-DDoS Premium instances.
ResourceGroupId String No rg-acfm2pz25js****

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

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

PageNumber String Yes 1

The number of the page to return.

PageSize String Yes 10

The number of entries to return on each page.

Ip String No 203.107.XX.XX

The IP address of the instance to query.

Remark String No doc-test

The remarks of the instance to query. Fuzzy match is supported.

Edition Integer No 9

The mitigation plan of the instance 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 Mainland China Acceleration (MCA) mitigation plan
  • 9: Anti-DDoS Pro instance of the Profession mitigation plan
Enabled Integer No 1

The traffic forwarding status of the instance to query. Valid values:

  • 0: The instance no longer forwards service traffic.
  • 1: The instance forwards service traffic as expected.
ExpireStartTime Long No 1640361500000

The beginning of the time range to query. Instances whose expiration time is later than the point in time are queried. This value is a UNIX timestamp. Unit: milliseconds.

ExpireEndTime Long No 1640361700000

The end of the time range to query. Instances whose expiration time is earlier than the point in time are queried. This value is a UNIX timestamp. Unit: milliseconds.

InstanceIds.N String No ddoscoo-cn-7pp2g9ed****

The ID of instance N to query. The maximum value of N is 200. You can specify up to 200 instances. Separate the IDs of multiple instances with commas (,).

Status.N Integer No 1

State N that is used to query instances. The maximum value of N is 2. You can specify up to two states. Separate the values with commas (,). Valid values:

  • 1: normal
  • 2: expired
Tag.N.Key String No test-key

The key of tag N that is added to the instance to query. The maximum value of N is 200. You can specify up to 200 tags. When you specify tags, take note of the following rules:

  • Each tag consists of a key (Key) and a value (Value), which are separated with a comma (,).
  • Separate multiple tags with commas (,).
Note The tag key (Key) and tag value (Value) must be specified in pairs.
Tag.N.Value String No test-value

The value of tag N that is added to the instance to query. The maximum value of N is 200. You can specify up to 200 tags. When you specify tags, take note of the following rules:

  • Each tag consists of a key (Key) and a value (Value), which are separated with a comma (,).
  • Separate multiple tags with commas (,).
Note The tag key (Key) and tag value (Value) must be specified in pairs.

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
TotalCount Long 1

The total number of the instances.

RequestId String A0AF40CC-814A-5A86-AEAA-6F19E88B8A39

The ID of the request, which is used to locate and troubleshoot issues.

Instances Array of Instance

The details about the instances.

Status Integer 1

The status of the instance. Valid values:

  • 1: normal
  • 2: expired
IpMode String fnat

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.
DebtStatus Integer 0

The overdue status of the instance. The value is fixed as 0, which indicates that your Alibaba Cloud account does not have overdue payments. The instance supports only the subscription billing method.

Edition Integer 9

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 Mainland China Acceleration (MCA) mitigation plan
  • 9: Anti-DDoS Pro instance of the Profession mitigation plan
IpVersion String Ipv4

The IP version of the instance. Valid values:

  • Ipv4: IPv4
  • Ipv6: IPv6
ExpireTime Long 1640361600000

The time when the instance expires. This value is a UNIX timestamp. Unit: milliseconds.

Remark String doc-test

The remarks of the instance.

CreateTime Long 1637751953000

The time when the instance was created. This value is a UNIX timestamp. Unit: milliseconds.

Enabled Integer 1

The traffic forwarding status of the instance. Valid values:

  • 0: The instance no longer forwards service traffic.
  • 1: The instance forwards service traffic as expected.
InstanceId String ddoscoo-cn-7pp2g9ed****

The ID of the instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeInstances
&ResourceGroupId=rg-acfm2pz25js****
&PageNumber=1
&PageSize=10
&Ip=203.107.XX.XX
&Remark=doc-test
&Edition=9
&Enabled=1
&ExpireStartTime=1640361500000
&ExpireEndTime=1640361700000
&InstanceIds=["ddoscoo-cn-7pp2g9ed****"]
&Status=[1]
&Tag=[{"Key":"test-key","Value":"test-value"}]
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstancesResponse>
    <TotalCount>1</TotalCount>
    <RequestId>A0AF40CC-814A-5A86-AEAA-6F19E88B8A39</RequestId>
    <Instances>
        <Status>1</Status>
        <IpMode>fnat</IpMode>
        <DebtStatus>0</DebtStatus>
        <Edition>9</Edition>
        <IpVersion>Ipv4</IpVersion>
        <ExpireTime>1640361600000</ExpireTime>
        <Remark>doc-test</Remark>
        <CreateTime>1637751953000</CreateTime>
        <Enabled>1</Enabled>
        <InstanceId>ddoscoo-cn-7pp2g9ed****</InstanceId>
    </Instances>
</DescribeInstancesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "A0AF40CC-814A-5A86-AEAA-6F19E88B8A39",
  "Instances" : [ {
    "Status" : 1,
    "IpMode" : "fnat",
    "DebtStatus" : 0,
    "Edition" : 9,
    "IpVersion" : "Ipv4",
    "ExpireTime" : 1640361600000,
    "Remark" : "doc-test",
    "CreateTime" : 1637751953000,
    "Enabled" : 1,
    "InstanceId" : "ddoscoo-cn-7pp2g9ed****"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.