查询用户EIP防护状态列表
功能介绍
查询用户所有EIP的Anti-DDoS防护状态信息,用户的EIP无论是否绑定到云服务器,都可以进行查询。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/antiddos
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
status |
否 |
String |
可选范围:
不带此参数默认所有列表,以neutron查询到的顺序为准。 |
limit |
否 |
String |
返回结果个数限制,取值范围:1~100 |
offset |
否 |
String |
偏移量,取值范围:0~2147483647 |
ips |
否 |
String |
IP地址,支持IPv4格式和IPv6格式输入,支持部分查询。例如“?ip=192.168”,会返回192.168.111.1和10.192.168.8所对应的EIP防护状态。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
Content-Type请求头 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
弹性IP总数 |
ddosStatus |
Array of EipDDosStatus objects |
防护状态列表 |
参数 |
参数类型 |
描述 |
---|---|---|
floating_ip_id |
String |
EIP的ID |
floating_ip_address |
String |
浮动IP地址 |
product_type |
String |
EIP所属类型,可选范围:
|
status |
String |
防护状态,可选范围:
|
clean_threshold |
Long |
清洗阈值 |
block_threshold |
String |
黑洞阈值 |
请求示例
无
响应示例
状态码:200
请求已成功
{ "total" : 2, "ddosStatus" : [ { "floating_ip_id" : "xxxxxxxx-xxxx-4947-9fa8-dda843ae5d1d", "floating_ip_address" : "10.10.10.10", "status" : "normal", "product_type" : "CNAD", "clean_threshold" : 1000, "block_threshold" : ">=20Gbps" }, { "floating_ip_id" : "xxxxxxxx-xxxx-4d33-a2dc-2ace2d0283de", "floating_ip_address" : "11.11.11.11", "status" : "normal", "product_type" : "Anti-DDoS", "clean_threshold" : 120, "block_threshold" : ">=20Gbps" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
错误码
请参见错误码。