全部产品
Search

搜索本产品

    DDoS 防护：DescribePackIpList - 查询防护包的防护IP列表信息

    文档中心

    DDoS 防护：DescribePackIpList - 查询防护包的防护IP列表信息

    更新时间：Sep 29, 2024

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

    接口说明

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

    QPS 限制

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

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    yundun-antiddosbag:DescribePackIpListget
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    PageNointeger是

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

    		1
    PageSizeinteger是

    分页查询时，设置每页包含受保护 IP 的数量。最大值：50。

    		10
    InstanceIdstring是

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

    说明 您可以调用 DescribeInstanceList 查询所有 DDoS 原生防护实例的 ID。
    		ddosbgp-cn-n6w1r7nz****
    Ipstring否

    要查询的受保护 IP。

    		47.98.XX.XX
    ProductNamestring否

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

    • ECS：表示云服务器 ECS 实例。
    • SLB：表示传统型负载均衡 CLB（原 SLB）实例。
    • EIP：表示弹性公网 IP 实例。因公网应用型负载均衡 ALB 实例使用弹性公网 IP，您需要通过 EIP 实例查询 ALB 的公网 IP。
    • WAF：表示 Web 应用防火墙实例。
    		ECS
    ResourceGroupIdstring否

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

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

    		rg-acfm2pz25js****
    RegionIdstring否

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

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

    成员账号 UID。

    		170858869679****

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

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

    返回参数

    名称类型描述示例值
    object
    Codestring

    本次请求的 HTTP 状态码。

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

    		200
    RequestIdstring

    本次请求的 ID。

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

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

    		1
    Successboolean

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

    • true：表示调用成功。
    • false：表示调用失败。
    		true
    IpListarray<object>

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

    Ipitemobject
    Statusstring

    IP 的当前状态。取值：

    • normal：表示正常（未受攻击）。
    • hole_begin：表示正处于黑洞状态。
    		normal
    Ipstring

    IP 地址。

    		47.98.XX.XX
    Remarkstring

    IP 所属云资产（例如，ECS 实例、SLB 实例等）的备注。

    说明 如果云资产无备注，则不返回该参数。
    		test
    Productstring

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

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

    受保护 IP 的所在地域。

    说明 如果受保护 IP 所在地域和实例所在地域一致，则不返回该参数。
    		cn-hangzhou
    MemberUidstring

    成员账号 UID。

    		170858869679****
    NsmStatusinteger

    近源压制状态。取值：

    • 1：表示正在近源压制中
    • 0：表示未在近源压制中
    		0
    NsmStartAtlong

    近源压制开始时间。

    		1715655000
    NsmExpireAtlong

    近源压制结束时间。

    		1715658000

    示例

    正常返回示例

    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",
      "Region": "cn-hangzhou",
      "MemberUid": "170858869679****\n",
      "NsmStatus": 0,
      "NsmStartAt": 1715655000,
      "NsmExpireAt": 1715658000
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-05-15OpenAPI 返回结构发生变更查看变更详情
    2024-02-28OpenAPI 返回结构发生变更查看变更详情
    2023-08-10OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-04-20OpenAPI 返回结构发生变更查看变更详情