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

Queries the details of Anti-DDoS Origin instances.

Operation description

This operation is used to query the details of all Anti-DDoS Origin instances owned by the current Alibaba Cloud account by paging, such as instance IDs, validity periods, and statuses.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Invoke this operation as needed.

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 ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not specify this parameter, the default resource group is used.	rg-acfm2pz25js****
InstanceIdList	string	No	The IDs of the Anti-DDoS Origin instances to query. Specify the value in the `["<Instance ID 1>","<Instance ID 2>",……]` format.	["ddosbgp-cn-oew1pjrk****"]
Remark	string	No	The remark of the Anti-DDoS Origin instance to query. Fuzzy match is supported.	test
PageNo	integer	Yes	The page number of the current page in a paging query. Settings the current page number.	1
PageSize	integer	Yes	The number of instances on each page in a paging query. Settings the number of instances per page.	10
IpVersion	string	No	The protocol type of the IP assets protected by the Anti-DDoS Origin instance to query. Valid values: IPv4: IPv4 protocol. IPv6: IPv6 protocol.	IPv4
InstanceType	string	No	The mitigation plan type of the Anti-DDoS Origin instance to query. Valid values: 0: Professional. 1: Enterprise.	0
Ip	string	No	The protected IP address of the Anti-DDoS Origin instance to query.	47.89.XX.XX
Orderby	string	No	The sort field for the Anti-DDoS Origin instance list. The value is fixed as expireTime, which indicates sorting by instance expiration time. You can use the Orderdire parameter to specify the sort order.	expireTime
Orderdire	string	No	The sort order. Valid values: desc (default): descending order by expiration time. asc: ascending order by expiration time.	desc
RegionId	string	No	The region ID of the Anti-DDoS Origin instance to query. Note You can call DescribeRegions to query all region IDs supported by Anti-DDoS Origin. Important This parameter is required. If it is not specified, the API returns DDosBgp.CheckError.InvalidRegion(400).	cn-hangzhou
Tag	array<object>	No	The tags bound to the Anti-DDoS Origin instances to query.
	object	No	The tags bound to the Anti-DDoS Origin instances to query.
Key	string	No	The key of the tag bound to the Anti-DDoS Origin instance to query.	test-key
Value	string	No	The value of the tag bound to the Anti-DDoS Origin instance to query.	test-value
InstanceTypeList	array	No	The mitigation plan types of the Anti-DDoS Origin instances to query.
	string	No	The mitigation plan type of the Anti-DDoS Origin instance to query. Valid values: 0: Professional. 1: Enterprise.	0

When calling this operation, in addition to the request parameters described in this topic, you must include Alibaba Cloud API common request parameters. For more information about common parameters, see Common parameters.

For the request format, see the request example in the Examples section of this topic.

Response elements

Element	Type	Description	Example
	object
Total	integer	The total number of Anti-DDoS Origin instances returned.	1
RequestId	string	The ID of the request.	381D5D33-BB8F-395F-8EE4-AE3BB4B523C4
InstanceList	array<object>	The details of the Anti-DDoS Origin instances.
	array<object>	The details of the Anti-DDoS Origin instances.
Status	string	The status of the instance. Valid values: 1: Normal. 2: Expired. 3: Released.	1
IpType	string	The protocol type of the IP assets protected by the instance. Valid values: IPv4: IPv4 protocol. IPv6: IPv6 protocol.	IPv4
AutoRenewal	boolean	Indicates whether auto-renewal is enabled for the instance. Valid values: true: Enabled. false: Disabled.	false
Remark	string	The remark of the instance.	test
ExpireTime	integer	The expiration time of the instance. The value is a UNIX timestamp. Unit: milliseconds.	1640275200000
Product	string	The type of the cloud service associated with the instance. This parameter is not returned by default. It is returned only when the Anti-DDoS Origin instance is created by another cloud service, with the corresponding cloud service code. Valid values: gamebox: The Anti-DDoS Origin instance is created by Game Security Box. eip: The Anti-DDoS Origin instance is created by an EIP with Anti-DDoS (Enhanced) enabled.	gamebox
GmtCreate	integer	The purchase time of the instance. The value is a UNIX timestamp. Unit: milliseconds.	1592886047000
InstanceId	string	The instance ID.	ddosbgp-cn-oew1pjrk****
InstanceType	string	The mitigation plan type of the instance. Valid values: 0: Professional. 1: Enterprise.	1
BlackholdingCount	string	The number of IP addresses that are in blackhole filtering status among the assets that are assigned public IP addresses protected by the instance. Note You can invoke DeleteBlackhole to deactivate blackhole filtering for a single protected IP address.	0
CoverageType	integer	The asset overwrite type of the instance. 1: Supports assets that are assigned public IP addresses in multiple regions globally. 2: Supports assets that are assigned public IP addresses in multiple regions in the Chinese mainland. 3: Supports assets that are assigned public IP addresses in multiple regions outside the Chinese mainland. 4: Supports assets that are assigned public IP addresses in a single region globally.	1
CommodityType	string	The commodity type of the instance. ddos_ddosorigin_public_cn: Anti-DDoS Origin 2.0 (Pay-as-you-go) China site. ddos_ddosorigin_public_intl: Anti-DDoS Origin 2.0 (Pay-as-you-go) International site.	ddos_ddosorigin_public_cn
DebtStatus	integer	The overdue payment status. Valid values: 0: No overdue payment. 1: Overdue payment.	0
AutoProtectCondition	object	The automatic binding condition.
Events	array	The events on which automatic binding is based.
	string	The event on which automatic binding is based. Valid values: any: Automatic binding based on scrubbing or blackhole filtering events. clean: Automatic binding based on scrubbing events. blackhole: Automatic binding based on blackhole filtering events.	any
ResourceGroupId	string	The resource group ID.	rg-aek3ccjxxxxx
LogExt	string	The full logs property.	{\"mitigationAnalysis\":\"on\",\"mitigationAnalysisCapacity\":1,\"ttl\":180}

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",
      "LogExt": "{\\\"mitigationAnalysis\\\":\\\"on\\\",\\\"mitigationAnalysisCapacity\\\":1,\\\"ttl\\\":180}"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.