调用DescribePackIpList查询单个DDoS原生防护实例的防护IP列表。

使用说明

本接口用于分页查询单个DDoS原生防护实例的防护IP列表,例如,IP地址、IP所属云资产类型、IP的当前状态(是否处于黑洞状态)等。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribePackIpList

要执行的操作。取值:DescribePackIpList

PageNo Integer 1

分页查询时,设置当前页面的页码。

PageSize Integer 10

分页查询时,设置每页包含受保护IP的数量。

InstanceId String ddosbgp-cn-n6w1r7nz****

要查询的DDoS原生防护实例的ID。

说明 您可以调用DescribeInstanceList查询所有DDoS原生防护实例的ID。
Ip String 47.98.XX.XX

要查询的受保护IP。

ProductName String ECS

要查询的受保护IP所属云资产类型。取值:

  • ECS:表示云服务器ECS实例。
  • SLB:表示传统型负载均衡CLB(原SLB)实例。
  • EIP:表示弹性公网IP实例。因公网应用型负载均衡ALB实例使用弹性公网IP,您需要通过EIP实例查询ALB的公网IP。
  • WAF:表示Web应用防火墙实例。
ResourceGroupId String rg-acfm2pz25js****

DDoS原生防护实例在资源管理服务中所属的资源组ID。

不设置该参数表示默认资源组。

RegionId String cn-hangzhou

DDoS原生防护实例所在地域ID。

说明 您可以调用DescribeRegions查询DDoS原生防护支持的所有地域ID。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
Code String 200

本次请求的HTTP状态码。

关于状态码的更多信息,请参见公共参数

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

本次请求的ID。

Total Integer 1

查询到的受保护IP的数量。

Success Boolean true

本次请求是否调用成功。取值:

  • true:表示调用成功。
  • false:表示调用失败。
IpList Array of Ipitem

受DDoS原生防护实例保护的IP列表。

Status String normal

IP的当前状态。取值:

  • normal:表示正常(未受攻击)。
  • hole_begin:表示正处于黑洞状态。
Ip String 47.98.XX.XX

IP地址。

Remark String test

IP所属云资产(例如,ECS实例、SLB实例等)的备注。

说明 如果云资产无备注,则不返回该参数。
Product String ECS

IP所属云资产的类型。取值:

  • ECS:表示云服务器ECS实例。
  • SLB:表示传统型负载均衡CLB(原SLB)实例。
  • EIP:表示弹性公网IP实例(包含应用型负载均衡ALB实例使用的弹性公网IP)。
  • WAF:表示Web应用防火墙实例。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribePackIpList
&PageNo=1
&PageSize=10
&InstanceId=ddosbgp-cn-n6w1r7nz****
&公共请求参数

正常返回示例

XML格式

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格式

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

错误码

访问错误中心查看更多错误码。