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

Usage notes

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribePackIpList

The operation that you want to perform. Set the value to DescribePackIpList.

PageNo Integer Yes 1

The number of the page to return.

PageSize Integer Yes 10

The number of entries to return on each page.

InstanceId String Yes ddosbgp-cn-n6w1r7nz****

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.
Ip String No 47.98.XX.XX

The protected IP address to query.

ProductName String No ECS

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.
ResourceGroupId String No rg-acfm2pz25js****

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.

RegionId String No cn-hangzhou

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.

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

Parameter Type Example Description
Code String 200

The HTTP status code of the request.

For more information about status codes, see Common parameters.

RequestId String 4FD1578A-BD77-50B7-A969-45A374A7ED22

The ID of the request.

Total Integer 1

The number of protected IP addresses.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
IpList Array of Ipitem

The list of IP addresses that are protected by the Anti-DDoS Origin instance.

Status String normal

The status of the IP address. Valid values:

  • normal: The IP address is in the normal state, which indicates that the IP address is not under attack.
  • hole_begin: Blackhole filtering is triggered for the IP address.
Ip String 47.98.XX.XX

The IP address.

Remark String test

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

Note If no remarks are provided for the asset, this parameter is not returned.
Product String ECS

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

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribePackIpList
&PageNo=1
&PageSize=10
&InstanceId=ddosbgp-cn-n6w1r7nz****
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePackIpListResponse>
    <Code>200</Code>
    <RequestId>4FD1578A-BD77-50B7-A969-45A374A7ED22</RequestId>
    <Total>1</Total>
    <Success>true</Success>
    <IpList>
        <Status>normal</Status>
        <Ip>47.98.XX.XX</Ip>
        <Remark>test</Remark>
        <Product>ECS</Product>
    </IpList>
</DescribePackIpListResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : "200",
  "RequestId" : "4FD1578A-BD77-50B7-A969-45A374A7ED22",
  "Total" : 1,
  "Success" : true,
  "IpList" : [ {
    "Status" : "normal",
    "Ip" : "47.98.XX.XX",
    "Remark" : "test",
    "Product" : "ECS"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.