Queries the versions and status information of one or more Anti-DDoS Pro or Anti-DDoS Premium instances, such as traffic forwarding status, expiration status, and overdue payment status.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeInstances |
The operation that you want to perform. Set the value to DescribeInstances. |
PageNumber | String | Yes | 1 |
The number of the page to return. For example, to query the returned results on the first page, set the value to 1. |
PageSize | String | Yes | 10 |
The number of entries to return on each page. Maximum value: 50. |
RegionId | String | No | cn-hangzhou |
The region ID of the instance. Valid values:
|
ResourceGroupId | String | No | default |
The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group. |
InstanceIds.N | RepeatList | No | ddoscoo-cn-mp91j1ao**** |
The ID of instance N. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.
|
Ip | String | No | 203.***. ***.117 |
The IP address of the instance that you want to query. Exact match is supported. |
Remark | String | No | test |
The description of the instance that you want to query. Fuzzy match is supported. |
Edition | Integer | No | 9 |
The mitigation plan of the instance that you want to query. Valid values:
|
Enabled | Integer | No | 1 |
The traffic forwarding status of the instance that you want to query. Valid values:
|
ExpireStartTime | Long | No | 1584460800000 |
The beginning of the expiration time range that you want to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
ExpireEndTime | Long | No | 1584560800000 |
The end of the expiration time range that you want to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
Status.N | RepeatList | No | 1 |
The expiration status N of the instance that you want to query. Valid values:
|
Tag.N.Key | String | No | testkey |
The key of tag N of the instance that you want to query. Note The tag key (Tag.N.Key) must match the tag value (Tag.N.Value).
|
Tag.N.Value | String | No | a |
The value of tag N of the instance that you want to query. Note The tag key (Tag.N.Key) must match the tag value (Tag.N.Value).
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Instances | Array |
The version and status information of an instance. |
|
CreateTime | Long | 1581946582000 |
The time when the instance was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
DebtStatus | Integer | 0 |
The status of overdue payments under the instance. The value is 0. Instances do not have overdue payments because Anti-DDoS Pro and Anti-DDoS Premium only support the subscription billing method. |
Edition | Integer | 9 |
The mitigation plan of the instance. Valid values:
|
Enabled | Integer | 1 |
The traffic forwarding status of the instance. Valid values:
|
ExpireTime | Long | 1584460800000 |
The expiration time of the instance. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
InstanceId | String | ddoscoo-cn-mp91j1ao**** |
The ID of the instance. |
Remark | String | test |
The description of the instance. |
Status | Integer | 1 |
The expiration status of the instance. Valid values:
|
RequestId | String | A09C1F98-4CC1-4A31-B8F3-9E4B7437189F |
The ID of the request. |
TotalCount | Long | 1 |
The total number of returned instances. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeInstances
&PageNumber=1
&PageSize=10
&<Common request parameters>
Sample success responses
XML
format
<DescribeInstancesResponse>
<Instances>
<Status>1</Status>
<InstanceId>ddoscoo-cn-mp91j1ao****</InstanceId>
<CreateTime>1581946582000</CreateTime>
<Enabled>1</Enabled>
<ExpireTime>1584460800000</ExpireTime>
<Edition>9</Edition>
<Remark>test</Remark>
<DebtStatus>0</DebtStatus>
</Instances>
<TotalCount>1</TotalCount>
<RequestId>A09C1F98-4CC1-4A31-B8F3-9E4B7437189F</RequestId>
</DescribeInstancesResponse>
JSON
format
{
"Instances": [
{
"Status": 1,
"InstanceId": "ddoscoo-cn-mp91j1ao****",
"CreateTime": 1581946582000,
"Enabled": 1,
"ExpireTime": 1584460800000,
"Edition": 9,
"Remark": "test",
"DebtStatus": 0
}
],
"TotalCount": 1,
"RequestId": "A09C1F98-4CC1-4A31-B8F3-9E4B7437189F"
}
Error codes
For a list of error codes, visit the API Error Center.