All Products
Search
Document Center

Anti-DDoS:DescribeInstanceList

Last Updated:Jan 03, 2023

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.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
yundun-antiddosbag:DescribeInstanceListRead
  • DdosBgp
    acs:yundun-antiddosbag:{#regionId}:{#accountId}:*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

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****
InstanceIdListstringNo

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****"]
RemarkstringNo

The remarks of the Anti-DDoS Origin instance to query. Fuzzy match is supported.

test
PageNointegerYes

The number of the page to return.

1
PageSizeintegerYes

The number of entries to return on each page.

10
IpVersionstringNo

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
InstanceTypestringNo

The mitigation plan of the Anti-DDoS Origin instance to query. Valid values:

  • 0: the Professional mitigation plan
  • 1: the Enterprise mitigation plan
0
IpstringNo

The IP address of the object that is protected by the Anti-DDoS Origin instance to query.

47.89.XX.XX
OrderbystringNo

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
OrderdirestringNo

The sorting method. Valid values:

  • desc: the descending order. This is the default value.
  • asc: the ascending order.
desc
RegionIdstringNo

The ID of the region where the Anti-DDoS Origin instance to query resides.

NoteYou can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
TagarrayNo
objectNo
KeystringNo

The key of the tag that is added to the Anti-DDoS Origin instance to query.

test-key
ValuestringNo

The value of the tag that is added to the Anti-DDoS Origin instance to query.

test-value

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

ParameterTypeDescriptionExample
object
Totallong

The total number of Anti-DDoS Origin instances.

1
RequestIdstring

The ID of the request.

381D5D33-BB8F-395F-8EE4-AE3BB4B523C4
InstanceListarray

The details about the Anti-DDoS Origin instance.

object
Statusstring

The status of the instance. Valid values:

  • 1: normal
  • 2: expired
  • 3: released
1
IpTypestring

The protocol type of the IP address asset that is protected by the instance. Valid values:

  • Ipv4: IPv4
  • Ipv6: IPv6
IPv4
AutoRenewalboolean

Indicates whether auto-renewal is enabled for the instance. Valid values:

  • true: enabled
  • false: disabled
false
Remarkstring

The remarks of the instance.

test
ExpireTimelong

The time when the instance expires. This value is a UNIX timestamp. Unit: milliseconds.

1640275200000
Productstring

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
GmtCreatelong

The time when the instance was purchased. This value is a UNIX timestamp. Unit: milliseconds.

1592886047000
InstanceIdstring

The ID of the instance.

ddosbgp-cn-oew1pjrk****
InstanceTypestring

The mitigation plan of the instance. Valid values:

  • 0: the Professional mitigation plan
  • 1: the Enterprise mitigation plan
1
BlackholdingCountstring

The number of protected public IP addresses for which blackhole filtering is triggered.

NoteYou can call the DeleteBlackhole operation to deactivate blackhole filtering for a protected IP address.
0

Example

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.