DescribeInstances - Anti-DDoS - Alibaba Cloud Documentation Center

Operation description

You can call the DescribeInstances operation to query the details of Anti-DDoS Pro or Anti-DDoS Premium instances within the Alibaba Cloud account by page. The details include the ID, mitigation plan, expiration time, and forwarding status.

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-ddoscoo:DescribeInstances	List	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs in Resource Management. If you do not specify this parameter, the instance belongs to the default resource group.	rg-acfm2pz25js****
PageNumber	string	Yes	The number of the page to return.	1
PageSize	string	Yes	The number of entries to return on each page.	10
Ip	string	No	The IP address of the instance to query.	203.107.XX.XX
Remark	string	No	The remarks of the instance to query. Fuzzy match is supported.	doc-test
Edition	integer	No	The mitigation plan of the instance to query. Valid values: 0: Anti-DDoS Premium instance of the Insurance mitigation plan 1: Anti-DDoS Premium instance of the Unlimited mitigation plan 2: Anti-DDoS Premium instance of the Mainland China Acceleration (MCA) mitigation plan 9: Anti-DDoS Pro instance of the Profession mitigation plan	9
Enabled	integer	No	The traffic forwarding status of the instance to query. Valid values: 0: The instance no longer forwards service traffic. 1: The instance forwards service traffic as expected.	1
ExpireStartTime	long	No	The beginning of the time range to query. Instances whose expiration time is later than the point in time are queried. This value is a UNIX timestamp. Unit: milliseconds.	1640361500000
ExpireEndTime	long	No	The end of the time range to query. Instances whose expiration time is earlier than the point in time are queried. This value is a UNIX timestamp. Unit: milliseconds.	1640361700000
InstanceIds	array	No
	string	No	The ID of instance N to query. The maximum value of N is 200. You can specify up to 200 instances. Separate the IDs of multiple instances with commas (,).	ddoscoo-cn-7pp2g9ed****
Status	array	No
	integer	No	The status of the instance to query. The maximum value of N is 2. You can specify up to two states. Separate the values with commas (,). Valid values: 1: normal 2: expired	1
Tag	object []	No
Key	string	No	The key of tag N that is added to the instance to query. The maximum value of N is 200. You can specify up to 200 tags. When you specify tags, take note of the following rules: Each tag consists of a key (Key) and a value (Value), which are separated by a comma (,). Separate multiple tags with commas (,). Note The tag key (Key) and tag value (Value) must be specified in pairs.	test-key
Value	string	No	The value of tag N that is added to the instance to query. The maximum value of N is 200. You can specify up to 200 tags. When you specify tags, take note of the following rules: Each tag consists of a key (Key) and a value (Value), which are separated by a comma (,). Separate multiple tags with commas (,). Note The tag key (Key) and tag value (Value) must be specified in pairs.	test-value

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of the instances.	1
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	A0AF40CC-814A-5A86-AEAA-6F19E88B8A39
Instances	object []	An array that consists of the details of the instances.
Status	integer	The status of the instance. Valid values: 1: normal 2: expired	1
IpMode	string	The IP address-based forwarding mode of the instance. Valid values: fnat: Requests from IPv4 addresses are forwarded to origin servers that use IPv4 addresses and requests from IPv6 addresses are forwarded to origin servers that use IPv6 addresses. v6tov4: All requests are forwarded to origin servers that use IPv4 addresses.	fnat
DebtStatus	integer	The overdue status of the instance. The value is fixed as 0, which indicates that your Alibaba Cloud account does not have overdue payments. The instance supports only the subscription billing method.	0
Edition	integer	The mitigation plan of the instance. Valid values: 0: Anti-DDoS Premium instance of the Insurance mitigation plan 1: Anti-DDoS Premium instance of the Unlimited mitigation plan 2: Anti-DDoS Premium instance of the MCA mitigation plan 9: Anti-DDoS Pro instance of the Profession mitigation plan	9
IpVersion	string	The IP version of the instance. Valid values: Ipv4: IPv4 Ipv6: IPv6	Ipv4
ExpireTime	long	The time when the instance expires. This value is a UNIX timestamp. Unit: milliseconds.	1640361600000
Remark	string	The remarks of the instance.	doc-test
CreateTime	long	The time when the instance is created. This value is a UNIX timestamp. Unit: milliseconds.	1637751953000
Enabled	integer	The forwarding status of the instance. Valid values: 0: The instance no longer forwards service traffic. 1: The instance forwards service traffic as expected.	1
InstanceId	string	The ID of the instance.	ddoscoo-cn-7pp2g9ed****
IsFirstOpenBw	long	Indicates whether the 95th percentile metering method has been enabled for the instance. Valid values: 0: The 95th percentile metering method has not been enabled for the instance. 1: The 95th percentile metering method has been enabled for the instance.	0
IsFirstOpenQps	long	Indicates whether the metering method of the 95th percentile burstable QPS is enabled for the instance. Valid values: 0: no 1: yes	0
Ip	string	The IP address of the instance.	203.199.XX.XX

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "A0AF40CC-814A-5A86-AEAA-6F19E88B8A39",
  "Instances": [
    {
      "Status": 1,
      "IpMode": "fnat",
      "DebtStatus": 0,
      "Edition": 9,
      "IpVersion": "Ipv4",
      "ExpireTime": 1640361600000,
      "Remark": "doc-test",
      "CreateTime": 1637751953000,
      "Enabled": 1,
      "InstanceId": "ddoscoo-cn-7pp2g9ed****",
      "IsFirstOpenBw": 0,
      "IsFirstOpenQps": 0,
      "Ip": "203.199.XX.XX"
    }
  ]
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2023-06-30

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-05-17

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.