All Products
Search
Document Center

Anti-DDoS:DescribePackIpList

Last Updated:Sep 29, 2024

Queries the IP addresses that are protected by a specific Anti-DDoS Origin instance.

Operation description

You can call the DescribePackIpList operation to query the details about each IP address that is protected by a specific Anti-DDoS Origin instance by page. The details include the IP address and the type of the cloud asset to which the IP address belongs. The details also include the status of the IP address, such as whether blackhole filtering is triggered for the IP address.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-antiddosbag:DescribePackIpListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNointegerYes

The number of the page to return.

1
PageSizeintegerYes

The number of entries to return on each page.

10
InstanceIdstringYes

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

Note You can call the DescribeInstanceList operation to query the IDs of all Anti-DDoS Origin instances.
ddosbgp-cn-n6w1r7nz****
IpstringNo

The protected IP address to query.

47.98.XX.XX
ProductNamestringNo

The type of the cloud asset to which the protected IP address to query belongs. Valid values:

  • ECS: an Elastic Compute Service (ECS) instance.
  • SLB: a Classic Load Balancer (CLB) instance, originally called a Server Load Balancer (SLB) instance.
  • EIP: an elastic IP address (EIP). An Internet-facing Application Load Balancer (ALB) instance uses an EIP. If the IP address belongs to the Internet-facing ALB instance, set this parameter to EIP.
  • WAF: a Web Application Firewall (WAF) instance.
ECS
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****
RegionIdstringNo

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

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
MemberUidstringNo

The ID of the member.

170858869679****

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
Codestring

The HTTP status code of the request.

For more information about status codes, see Common parameters.

200
RequestIdstring

The ID of the request.

4FD1578A-BD77-50B7-A969-45A374A7ED22
Totalinteger

The number of protected IP addresses.

1
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
true
IpListarray<object>

The IP addresses that are protected by the instance.

Ipitemobject
Statusstring

The status of the IP address. Valid values:

  • normal: The IP address is not under attack.
  • hole_begin: Blackhole filtering is triggered for the IP address.
normal
Ipstring

The IP address.

47.98.XX.XX
Remarkstring

The description of the cloud asset to which the IP address belongs. The asset can be an ECS instance or an SLB instance.

Note If no descriptions are provided for the asset, this parameter is not returned.
test
Productstring

The type of the cloud asset to which the IP address belongs. Valid values:

  • ECS: an ECS instance.
  • SLB: a CLB (formerly SLB) instance.
  • EIP: an EIP. If the IP address belongs to an ALB instance, the value EIP is returned.
  • WAF: a WAF instance.
ECS
Regionstring

The region to which the protected IP address belongs.

Note If the protected IP address is in the same region as the instance, this parameter is not returned.
cn-hangzhou
MemberUidstring

The ID of the member.

170858869679****
NsmStatusinteger

The status of the near-origin traffic diversion feature. Valid values:

  • 1: The near-origin traffic diversion feature is enabled.
  • 0: The near-origin traffic diversion feature is disabled.
0
NsmStartAtlong

The time when the near-origin traffic diversion feature was enabled.

1715655000
NsmExpireAtlong

The time when the near-origin traffic diversion feature was disabled.

1715658000

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
2024-05-15The response structure of the API has changedView Change Details
2024-02-28The response structure of the API has changedView Change Details
2023-08-10The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-04-20The response structure of the API has changedView Change Details