All Products
Search

This Product

    Anti-DDoS:DescribePackIpList

    Document Center

    Anti-DDoS:DescribePackIpList

    Last Updated:Jan 31, 2023

    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.

    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:DescribePackIpListList
    • DdosBgp
      acs:yundun-antiddosbag:{#regionId}:{#accountId}:*
      without
    		without

    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.

    NoteYou 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.

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

    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

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

    object
    Statusstring

    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.
    		normal
    Ipstring

    The IP address.

    		47.98.XX.XX
    Remarkstring

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

    NoteIf no remarks 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: an CLB instance.
    • EIP: an EIP. If the IP address belongs to an ALB instance, the value EIP is returned.
    • WAF: a WAF instance.
    		ECS

    Example

    Normal return example

    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"
    }
  ]
}

    Error codes

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