DescribePackIpList - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the list of protected IP addresses for a single Anti-DDoS Origin instance.

Operation description

You can call this operation to query a paginated list of protected IP addresses for an Anti-DDoS Origin instance. The query returns details such as the IP addresses, the types of cloud assets to which the IP addresses belong, and their current status, such as whether they are under blackhole filtering.

QPS limit

This operation has a queries per second (QPS) limit of 10 for each user. Calls that exceed this limit are throttled, which may affect your business. We recommend that you call this operation within this limit.

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:DescribePackIpList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of protected IP addresses to return on each page. The maximum value is 50.	10
InstanceId	string	Yes	The ID of the Anti-DDoS Origin instance to query. Note Call DescribeInstanceList to query the IDs of all Anti-DDoS Origin instances.	ddosbgp-cn-n6w1r7nz****
Ip	string	No	The protected IP address to query.	47.98.XX.XX
ProductName	string	No	The type of the cloud asset to which the protected IP address belongs. Valid values: ECS: an Elastic Compute Service (ECS) instance. SLB: a Classic Load Balancer (CLB) instance. EIP: an Elastic IP Address (EIP) instance. Because Application Load Balancer (ALB) instances use EIPs, query the public IP address of an ALB instance using the EIP. WAF: a Web Application Firewall (WAF) instance.	ECS
ResourceGroupId `deprecated`	string	No	The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not set this parameter, the instance belongs to the default resource group.	rg-acfm2pz25js****
RegionId	string	No	The region ID of the Anti-DDoS Origin instance. Note Call DescribeRegions to query the IDs of all regions that Anti-DDoS Origin supports.	cn-hangzhou
MemberUid	string	No	The UID of the member account.	170858869679****

In addition to the parameters specific to this operation, you must also specify the common request parameters. For more information about common request parameters, see Common parameters.

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

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code of the request. For more information about status codes, see Common parameters.	200
RequestId	string	The ID of the request.	4FD1578A-BD77-50B7-A969-45A374A7ED22
Total	integer	The number of protected IP addresses that are returned.	1
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
IpList	array<object>	The list of IP addresses that are protected by the Anti-DDoS Origin instance.
	object
Status	string	The current status of the IP address. Valid values: normal: The IP address is not under attack. hole_begin: The IP address is in blackhole filtering status.	normal
Ip	string	The IP address.	47.98.XX.XX
Remark	string	The remarks on the cloud asset to which the IP address belongs, such as an ECS instance or an SLB instance. Note This parameter is not returned if no remarks are specified for the cloud asset.	test
Product	string	The type of the cloud asset to which the IP address belongs. Valid values: ECS: an ECS instance. SLB: a CLB instance. EIP: an EIP instance. This includes the EIP used by an ALB instance. WAF: a WAF instance.	ECS
Region	string	The region where the protected IP address is deployed. Note This parameter is not returned if the protected IP address is deployed in the same region as the instance.	cn-hangzhou
MemberUid	string	The UID of the member account.	170858869679****
NsmStatus	integer	The status of cross-border traffic blocking. Valid values: 1: Cross-border traffic is being blocked. 0: Cross-border traffic is not blocked.	0
NsmStartAt	integer	The start time of cross-border traffic blocking.	1715655000
NsmExpireAt	integer	The end time of cross-border traffic blocking.	1715658000

Examples

Success response

JSON format

{
  "Code": "200",
  "RequestId": "4FD1578A-BD77-50B7-A969-45A374A7ED22",
  "Total": 1,
  "Success": true,
  "IpList": [
    {
      "Status": "normal",
      "Ip": "47.98.XX.XX",
      "Remark": "test",
      "Product": "ECS",
      "Region": "cn-hangzhou",
      "MemberUid": "170858869679****\n",
      "NsmStatus": 0,
      "NsmStartAt": 1715655000,
      "NsmExpireAt": 1715658000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.