Queries the details of all Anti-DDoS Origin instances.
Usage notes
You can call the DescribeInstanceList operation to query the details of all Anti-DDoS Origin instances within your Alibaba Cloud account by page. The details include the ID, validity period, and status of each instance.
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 | DescribeInstanceList |
The operation that you want to perform. Set the value to DescribeInstanceList. |
ResourceGroupId | String | No | rg-acfm2pz25js**** |
The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not specify this parameter, the instance belongs to the default resource group. |
InstanceIdList | String | No | ["ddosbgp-cn-oew1pjrk****"] |
The IDs of the Anti-DDoS Origin instances to query. Specify the value is in the |
Remark | String | No | test |
The remarks of the Anti-DDoS Origin instance to query. Fuzzy match is supported. |
PageNo | Integer | Yes | 1 |
The number of the page to return. |
PageSize | Integer | Yes | 10 |
The number of entries to return on each page. |
IpVersion | String | No | IPv4 |
The protocol type of the IP address asset that is protected by the Anti-DDoS Origin instance to query. Valid values:
|
InstanceType | String | No | 0 |
The mitigation plan of the Anti-DDoS Origin instance to query. Valid values:
|
Ip | String | No | 47.89.XX.XX |
The IP address of the object that is protected by the Anti-DDoS Origin instance to query. |
Orderby | String | No | expireTime |
The field that is used to sort the Anti-DDoS Origin instances. Set the value to expireTime, which indicates that the instances are sorted based on the expiration time. You can set the Orderdire parameter to specify the sorting method. |
Orderdire | String | No | desc |
The sorting method. Valid values:
|
RegionId | String | No | cn-hangzhou |
The ID of the region where the Anti-DDoS Origin instance to query resides. Note You can call the DescribeRegions operation to query the most recent region list.
|
Tag.N.Key | String | No | test-key |
The key of the tag that is added to the Anti-DDoS Origin instance to query. |
Tag.N.Value | String | No | test-value |
The value of the tag that is added to the Anti-DDoS Origin instance to query. |
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 |
---|---|---|---|
Total | Long | 1 |
The total number of Anti-DDoS Origin instances. |
RequestId | String | 381D5D33-BB8F-395F-8EE4-AE3BB4B523C4 |
The ID of the request. |
InstanceList | Array of Instance |
The details about the Anti-DDoS Origin instance. |
|
Status | String | 1 |
The status of the instance. Valid values:
|
IpType | String | IPv4 |
The protocol type of the IP address asset that is protected by the instance. Valid values:
|
AutoRenewal | Boolean | false |
Indicates whether auto-renewal is enabled for the instance. Valid values:
|
Remark | String | test |
The remarks of the instance. |
ExpireTime | Long | 1640275200000 |
The time when the instance expires. This value is a UNIX timestamp. Unit: milliseconds. |
Product | String | gamebox |
The type of the cloud service that is associated with the Anti-DDoS Origin instance. By default, this parameter is not returned. If the Anti-DDoS Origin instance is created by using a different cloud service, the code of the cloud service is returned. Valid values:
|
GmtCreate | Long | 1592886047000 |
The time when the instance was purchased. This value is a UNIX timestamp. Unit: milliseconds. |
InstanceId | String | ddosbgp-cn-oew1pjrk**** |
The ID of the instance. |
InstanceType | String | 1 |
The mitigation plan of the instance. Valid values:
|
BlackholdingCount | String | 0 |
The number of protected public IP addresses for which blackhole filtering is triggered. Note You can call the DeleteBlackhole operation to deactivate blackhole filtering for a protected IP address.
|
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeInstanceList
&PageNo=1
&PageSize=10
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeInstanceListResponse>
<Total>1</Total>
<RequestId>381D5D33-BB8F-395F-8EE4-AE3BB4B523C4</RequestId>
<InstanceList>
<Status>1</Status>
<IpType>IPv4</IpType>
<AutoRenewal>false</AutoRenewal>
<Remark>test</Remark>
<ExpireTime>1640275200000</ExpireTime>
<Product>ECS</Product>
<GmtCreate>1592886047000</GmtCreate>
<InstanceId>ddosbgp-cn-oew1pjrk****</InstanceId>
<InstanceType>1</InstanceType>
<BlackholdingCount>0</BlackholdingCount>
</InstanceList>
</DescribeInstanceListResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Total" : 1,
"RequestId" : "381D5D33-BB8F-395F-8EE4-AE3BB4B523C4",
"InstanceList" : [ {
"Status" : "1",
"IpType" : "IPv4",
"AutoRenewal" : false,
"Remark" : "test",
"ExpireTime" : 1640275200000,
"Product" : "ECS",
"GmtCreate" : 1592886047000,
"InstanceId" : "ddosbgp-cn-oew1pjrk****",
"InstanceType" : "1",
"BlackholdingCount" : "0"
} ]
}
Error codes
For a list of error codes, visit the API Error Center.