All Products
Search

This Product

    Anti-DDoS:DescribePackIpList

    Document Center

    Anti-DDoS:DescribePackIpList

    Last Updated:Oct 26, 2026

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

    Operation description

    This operation performs a paged query to retrieve the list of protected IP addresses for a single Anti-DDoS Origin instance. The information includes the IP address, the cloud asset type to which the IP address belongs, and the current status of the IP address, such as the blackhole filtering status.

    QPS limit

    The queries per second (QPS) limit per user is 10. If the limit is exceeded, API calls are throttled, which may affect your services. Call the operation at a reasonable frequency.

    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 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. Maximum value: 50.

    10
    InstanceId

    string

    Yes

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

    string

    No

    The protected IP address to query.

    47.98.XX.XX
    ProductName

    string

    No

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

    • ECS: ECS instance.

    • SLB: Classic Load Balancer (CLB) instance.

    • EIP: elastic IP address (EIP). Because Internet-facing Application Load Balancer (ALB) instances use EIPs, you must query the public IP addresses of ALB instances by using EIPs.

    • WAF: 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 specify this parameter, the default resource group is used.

    rg-acfm2pz25js****
    RegionId

    string

    No

    The region ID of the Anti-DDoS Origin instance.

    Note

    You can call the DescribeRegions operation to query all region IDs supported by Anti-DDoS Origin.

    cn-hangzhou
    MemberUid

    string

    No

    The UID of the member account.

    170858869679****

    When you call this operation, you must add the common request parameters of Alibaba Cloud API in addition to the request parameters described in this topic. For more information about common request parameters, see Common parameters.

    For more information about the request format, see the Examples section in 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 queried.

    1
    Success

    boolean

    Indicates whether the request is successful. Valid values:

    • true: The request is successful.

    • false: The request fails.

    true
    IpList

    array<object>

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

    object

    Status

    string

    The current status of the IP address. Valid values:

    • normal: The IP address is normal and not under attack.

    • hole_begin: The IP address is under blackhole filtering.

    normal
    Ip

    string

    The IP address.

    47.98.XX.XX
    Remark

    string

    The description of the cloud asset to which the IP address belongs, such as an ECS instance or a CLB instance.

    Note

    If the cloud asset has no description, this parameter is not returned.

    test
    Product

    string

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

    • ECS: ECS instance.

    • SLB: Classic Load Balancer (CLB) instance.

    • EIP: EIP, including the EIPs used by Application Load Balancer (ALB) instances.

    • WAF: Web Application Firewall (WAF) instance.

    ECS
    Region

    string

    The region of the protected IP address.

    Note

    If the region of the protected IP address is the same as the region of the instance, this parameter is not returned.

    cn-hangzhou
    MemberUid

    string

    The UID of the member account.

    170858869679****

    NsmStatus

    integer

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

    • 1: Near-origin traffic diversion is in progress.

    • 0: Near-origin traffic diversion is not in progress.

    0
    NsmStartAt

    integer

    The start time of near-origin traffic diversion.

    1715655000
    NsmExpireAt

    integer

    The end time of near-origin traffic diversion.

    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.