更新时间:2024-09-27 GMT+08:00
分享

查询可绑定的防护对象列表

功能介绍

查询可绑定的防护对象列表

调用方法

请参见如何调用API

URI

GET /v1/cnad/packages/{package_id}/unbound-protected-ips

表1 路径参数

参数

是否必选

参数类型

描述

package_id

String

防护包id

最小长度:32

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

开始查询的偏移量,默认值:0

最小值:0

最大值:65535

limit

Integer

每页显示的条目数量,默认值:2000

最小值:1

最大值:2000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:32

最大长度:2097152

Content-Type

String

Content-Type

缺省值:application/json;charset=utf8

最小长度:1

最大长度:255

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数

最小值:0

最大值:2147483647

ips

Array of ProtectedIpResponse objects

防护ip列表

数组长度:0 - 2147483647

表5 ProtectedIpResponse

参数

参数类型

描述

id

String

防护IP的Id

最小长度:32

最大长度:64

ip

String

防护IP

最小长度:7

最大长度:128

type

String

类型。VPN:VPN;NAT:NAT;VIP:VIP;CCI:CCI;EIP:弹性公网IP;ELB:弹性负载均衡;REROUTING_IP:REROUTING_IP;SubEni:SubEni;NetInterFace:NetInterFace;

name

String

名字

最小长度:1

最大长度:255

status

Integer

状态:0 - 正常, 1 - 清洗中, 2 - 黑洞中

最小值:0

最大值:2

status_detail

IpStatusDetail object

封堵信息

policy_name

String

策略名

最小长度:1

最大长度:255

region

String

所属region

最小长度:1

最大长度:255

package_id

String

防护包id

最小长度:32

最大长度:64

package_name

String

防护包名

最小长度:0

最大长度:255

tags

String

TMS标签

最小长度:1

最大长度:255

tag

String

本地标签

最小长度:0

最大长度:255

is_resale

Boolean

默认false,表示是否转售版的IP,不需要展示策略和报表

package_version

String

package_version。cnad_pro:全力防基础版;cnad_ip:标准版;cnad_full_high:全力防高级版;cnad_v2:原生防护2.0

表6 IpStatusDetail

参数

参数类型

描述

block_time

Long

封堵时间

最小值:0

最大值:9223372036854775807

unblock_time

Long

解封时间

最小值:0

最大值:9223372036854775807

请求示例

响应示例

状态码: 200

OK

{
  "ips" : [ {
    "id" : "2b93b3ed-7aed-4b73-be77-d04318cbda5e",
    "ip" : "100.85.112.111",
    "is_resale" : false,
    "tags" : "{}",
    "type" : "EIP"
  } ],
  "total" : 1
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档