Query Anti-DDoS Origin instances with DescribeInstanceList - Anti-DDoS

Retrieves the details of all Anti-DDoS Origin instances.

Operation description

Retrieves the details of all Anti-DDoS Origin instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-antiddosbag:DescribeInstanceList

get

*All Resource

*

None

Request parameters

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

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.

Response elements

Element	Type	Description	Example
	object
Total	integer	The details about the Anti-DDoS Origin instances.	1
RequestId	string	The details about the Anti-DDoS Origin instance.	381D5D33-BB8F-395F-8EE4-AE3BB4B523C4
InstanceList	array<object>	The details about the Anti-DDoS Origin instances.
	array<object>	The details about the Anti-DDoS Origin instances.
Status	string	Indicates whether auto-renewal is enabled for the instance. Valid values: true false	1
IpType	string	The description of the instance.	IPv4
AutoRenewal	boolean	The time when the instance expires. The value is a UNIX timestamp. Unit: milliseconds.	false
Remark	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.	test
ExpireTime	integer	The time when the instance was purchased. The value is a UNIX timestamp. Unit: milliseconds.	1640275200000
Product	string	The ID of the instance.	gamebox
GmtCreate	integer	The mitigation plan of the instance. Valid values: 0: the Professional mitigation plan 1: the Enterprise mitigation plan	1592886047000
InstanceId	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.	ddosbgp-cn-oew1pjrk****
InstanceType	string	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
BlackholdingCount	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).	0
CoverageType	integer	Indicates whether overdue payments exist. Valid values: 0: Overdue payments do not exist. 1: Overdue payments exist.	1
CommodityType	string	The condition that triggers automatic association of the instance with an object.	ddos_ddosorigin_public_cn
DebtStatus	integer	The events that trigger automatic association.	0
AutoProtectCondition	object	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.
Events	array	Events which result in auto binding.
	string	Event which result in auto binding. 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
ResourceGroupId	string	The resource group ID.	rg-aek3ccjxxxxx

Examples

Success response

JSON format

{
  "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",
      "DebtStatus": 0,
      "AutoProtectCondition": {
        "Events": [
          "any"
        ]
      },
      "ResourceGroupId": "rg-aek3ccjxxxxx"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.