DescribeInstanceList - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the details of all Anti-DDoS Origin instances.

Operation description

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-antiddosbag:DescribeInstanceList	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	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.	rg-acfm2pz25js****
InstanceIdList	string	No	The IDs of the Anti-DDoS Origin instances to query. Specify the value is in the `["<Instance ID 1>","<Instance ID 2>",……]` format.	["ddosbgp-cn-oew1pjrk****"]
Remark	string	No	The remarks of the Anti-DDoS Origin instance to query. Fuzzy match is supported.	test
PageNo	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	10
IpVersion	string	No	The protocol type of the IP address asset that is protected by the Anti-DDoS Origin instance to query. Valid values: Ipv4: IPv4 Ipv6: IPv6	IPv4
InstanceType	string	No	The mitigation plan of the Anti-DDoS Origin instance to query. Valid values: 0: the Professional mitigation plan 1: the Enterprise mitigation plan	0
Ip	string	No	The IP address of the object that is protected by the Anti-DDoS Origin instance to query.	47.89.XX.XX
Orderby	string	No	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.	expireTime
Orderdire	string	No	The sorting method. Valid values: desc: the descending order. This is the default value. asc: the ascending order.	desc
RegionId	string	No	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.	cn-hangzhou
Tag	array<object>	No	The tags that are added to the Anti-DDoS Origin instance.
	object	No	The tag that is added to the Anti-DDoS Origin instance.
Key	string	No	The key of the tag that is added to the Anti-DDoS Origin instance.	test-key
Value	string	No	The value of the tag that is added to the Anti-DDoS Origin instance.	test-value
InstanceTypeList	array	No	The mitigation plan of the Anti-DDoS Origin instance.
	string	No	The mitigation plan of the Anti-DDoS Origin instance. Valid values: 0: the Professional mitigation plan. 1: the Enterprise mitigation plan.	0

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	Description	Example
	object
Total	long	The total number of Anti-DDoS Origin instances.	1
RequestId	string	The ID of the request.	381D5D33-BB8F-395F-8EE4-AE3BB4B523C4
InstanceList	array<object>	The details about the Anti-DDoS Origin instances.
Instance	object	The details about the Anti-DDoS Origin instance.
Status	string	The status of the instance. Valid values: 1: normal 2: expired 3: released	1
IpType	string	The protocol type of the IP address asset that is protected by the instance. Valid values: Ipv4 Ipv6	IPv4
AutoRenewal	boolean	Indicates whether auto-renewal is enabled for the instance. Valid values: true false	false
Remark	string	The description of the instance.	test
ExpireTime	long	The time when the instance expires. The value is a UNIX timestamp. Unit: milliseconds.	1640275200000
Product	string	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: gamebox: The Anti-DDoS Origin instance is created by using Game Security Box. eip: The Anti-DDoS Origin instance is created by using an elastic IP address (EIP) for which Anti-DDoS (Enhanced Edition) is enabled.	gamebox
GmtCreate	long	The time when the instance was purchased. The value is a UNIX timestamp. Unit: milliseconds.	1592886047000
InstanceId	string	The ID of the instance.	ddosbgp-cn-oew1pjrk****
InstanceType	string	The mitigation plan of the instance. Valid values: 0: the Professional mitigation plan 1: the Enterprise mitigation plan	1
BlackholdingCount	string	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.	0
CoverageType	integer	The application scope of the instance. 1: The instance supports public IP addresses in all regions. 2: The instance supports public IP addresses in regions in the Chinese mainland. 3: The instance supports public IP addresses in regions outside the Chinese mainland. 4: The instance supports public IP addresses in a region in or outside the Chinese mainland.	1
CommodityType	string	The type of the instance. ddos_ddosorigin_public_cn: Anti-DDoS Origin 2.0 (Pay-as-you-go) on the China site (aliyun.com). ddos_ddosorigin_public_intl: Anti-DDoS Origin 2.0 (Pay-as-you-go) on the International site (alibabacloud.com).	ddos_ddosorigin_public_cn
AutoProtectCondition	object	The condition that triggers automatic association of the instance with an object.
Events	array	The events that trigger automatic association.
events	string	The event that triggers automatic association. Valid values: any: The instance is automatically associated with an object based on traffic scrubbing events or blackhole filtering events. clean: The instance is automatically associated with an object based on traffic scrubbing events. blackhole: The instance is automatically associated with an object based on blackhole filtering events.	any

Examples

Sample success responses

JSONformat

{
  "Total": 1,
  "RequestId": "381D5D33-BB8F-395F-8EE4-AE3BB4B523C4",
  "InstanceList": [
    {
      "Status": "1",
      "IpType": "IPv4",
      "AutoRenewal": false,
      "Remark": "test",
      "ExpireTime": 1640275200000,
      "Product": "gamebox",
      "GmtCreate": 1592886047000,
      "InstanceId": "ddosbgp-cn-oew1pjrk****",
      "InstanceType": "1",
      "BlackholdingCount": "0",
      "CoverageType": 1,
      "CommodityType": "ddos_ddosorigin_public_cn",
      "AutoProtectCondition": {
        "Events": [
          "any"
        ]
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-02-28	The response structure of the API has changed	View Change Details
2023-11-23	The response structure of the API has changed	View Change Details
2023-04-20	The request parameters of the API has changed. The response structure of the API has changed	View Change Details