Queries the details of Anti-DDoS Origin Enterprise instances.

Note Anti-DDoS Origin API operations are available for only Anti-DDoS Origin Enterprise users.

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 DescribeInstanceList

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

PageNo Integer Yes 1

The number of the page to return. Default value: 1.

PageSize Integer Yes 10

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

ResourceGroupId String No test

The ID of the resource group to query.

InstanceIdList String No ['ddosbgp-cn-xx','ddosbpg-cn-xxx']

The IDs of Anti-DDoS instances to query. If you want to query multiple instances, separate the IDs with commas (,). The parameter must be passed to the API operation in the JSON format, for example, ['ddosbgp-cn-xx','ddosbpg-cn-xxx'].

Note If the parameter is empty, the details of all Anti-DDoS Origin Enterprise instances are returned.
Remark String No test

The alias of the Anti-DDoS Origin Enterprise instance.

Note If the parameter is empty, the details of all Anti-DDoS Origin Enterprise instances are returned.
DdosRegionId String No cn-hangzhou

The ID of the region where the Anti-DDoS Origin Enterprise instance resides.

IpVersion String No IPv4

The IP version. Valid values:

Note If the parameter is empty, the details of all Anti-DDoS Origin Enterprise instances are returned.
  • IPv4
  • IPv6
InstanceType String No 0

The protection plan. Valid values:

Note If the parameter is empty, the details of all Anti-DDoS Origin Enterprise instances are returned.
  • 0: Pro edition
  • 1: Enterprise edition
Ip String No 1.1.1.1

The IP address of the protection target that is protected by the Anti-DDoS Origin Enterprise instance.

Note If the parameter is empty, the details of all Anti-DDoS Origin Enterprise instances are returned.
Orderby String No expireTime

The key by which you want to sort the entries. Valid value: expireTime, which specifies the expiration time.

Orderdire String No asc

The order in which you want to sort the entries. Valid values:

  • desc: specifies the descending order
  • asc: specifies the ascending order
Tag.N.Key String No test

The key of each tag. The N is a digit that starts from 1. If multiple tags exist, the keys are passed to the API operation in sequence, for example, Tag.1.Key, Tag.2.Key, and Tag.3.Key.

Tag.N.Value String No test

The key of each tag. The N is a digit that starts from 1. If multiple tags exist, the values are passed to the API operation in sequence, for example, Tag.1.Value, Tag.2.Value, and Tag.3.Value.

Response parameters

Parameter Type Example Description
InstanceList Array

The list of Anti-DDoS Origin Enterprise instances and the details of each instance.

AutoRenewal Boolean false

Indicates whether auto-renewal is enabled for the Anti-DDoS Origin Enterprise instance.

BlackholdingCount String 0

The number of IP addresses that are in the blackholing state.

ExpireTime Long 1560009600000

The expiration time of the Anti-DDoS Origin Enterprise instance.

GmtCreate Long 1554708159000

The creation time of the Anti-DDoS Origin Enterprise instance.

InstanceId String ddosbgp-cn-xx

The ID of an Anti-DDoS Origin Enterprise instance.

InstanceType String 1

The protection plan. Valid values:

  • 0: Pro edition
  • 1: Enterprise edition
IpType String IPv4

The IP version. Valid values:

  • IPv4
  • IPv6
Product String SLB

The type of service to be protected. Valid values:

  • ECS
  • SLB
  • EIP
  • WAF
Remark String test

The alias of the Anti-DDoS Origin Enterprise instance.

Status String 1

The status of the Anti-DDoS Origin Enterprise instance. Valid values:

  • 1: indicates that the Anti-DDoS Origin Enterprise instance is in the normal state.
  • 2: indicates that the Anti-DDoS Origin Enterprise instance has expired.
  • 3: indicates that the Anti-DDoS Origin Enterprise instance is released.
RequestId String C3F7E6AE-43B2-4730-B6A3-FD17552B8F65

The ID of the request.

Total Long 1

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeInstanceList
&PageNo=1
&PageSize=10
&<Common request parameters>

Sample success response

XML format

<DescribeInstanceListResponse>
     <RequestId>C3F7E6AE-43B2-4730-B6A3-FD17552B8F65</RequestId>
     <InstanceList>
           <Instance>
                 <Status>1</Status>
                 <AutoRenewal>true</AutoRenewal>
                 <IpType>IPv4</IpType>
                 <ExpireTime>1560009600000</ExpireTime>
                 <InstanceId>ddosbgp-cn-xx</InstanceId>
                 <GmtCreate>1554708159000</GmtCreate>
                 <Remark>test</Remark>
                 <BlackholdingCount>0</BlackholdingCount>
           </Instance>
     </InstanceList>
     <Total>1</Total>
</DescribeInstanceListResponse>

JSON format

{
    "RequestId": "C3F7E6AE-43B2-4730-B6A3-FD17552B8F65",
    "InstanceList": [
        {
            "Status": "1",
            "AutoRenewal": true,
            "IpType": "IPv4",
            "ExpireTime": 1560009600000,
            "InstanceId": "ddosbgp-cn-xx",
            "GmtCreate": 1554708159000,
            "Remark": "test",
            "BlackholdingCount": 0
        }
    ],
    "Total": 1
}

Error codes

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