查询防护对象列表
功能介绍
查询防护对象列表
调用方法
请参见如何调用API。
URI
GET /v1/cnad/protected-ips
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
否 |
Integer |
开始查询的偏移量,默认值:0 最小值：0 最大值：65535 |
limit |
否 |
Integer |
每页显示的条目数量,默认值:2000 最小值：1 最大值：2000 |
package_id |
否 |
String |
防护包id 最小长度：32 最大长度：64 |
policy_id |
否 |
String |
策略id 最小长度：32 最大长度：64 |
ip |
否 |
String |
防护ip 最小长度：7 最大长度：128 |
tag |
否 |
String |
本地标签 最小长度：1 最大长度：255 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：32 最大长度：2097152 |
Content-Type |
是 |
String |
Content-Type 缺省值：application/json;charset=utf8 最小长度：1 最大长度：255 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
total |
Integer |
总数 最小值：0 最大值：2147483647 |
items |
Array of ProtectedIpResponse objects |
防护ip列表 数组长度：0 - 2147483647 |
参数 |
参数类型 |
描述 |
|---|---|---|
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_ep：铂金版；cnad_full_high：全力防高级版；cnad_vic：按需版；cnad_intl_ep：国际站铂金版 |
请求示例
无
响应示例
状态码： 200
OK
{
"items" : [ {
"id" : "7f0e3af2-455a-4a47-b95c-49137794f0c5",
"ip" : "100.85.222.60",
"is_resale" : false,
"package_id" : "17f8f630-0714-4b3a-aedf-3983d7b98124",
"package_name" : "kxnkxn99",
"package_version" : "cnad_ip",
"policy_name" : "tesy",
"region" : "cn-north-7",
"status" : 0,
"type" : "EIP"
} ],
"total" : 1
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。
