查看eip告警白名单
功能介绍
查看eip告警白名单
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/eip/alarm-whitelist/{fw_instance_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
fw_instance_id |
是 |
String |
防火墙ID,可通过防火墙ID获取方式获取 |
project_id |
是 |
String |
项目ID,可以从调API处获取,也可以从控制台获取。可通过项目ID获取方式获取 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ip_address |
否 |
String |
IP地址 |
limit |
是 |
Integer |
每页显示个数,范围为1-1024 |
offset |
是 |
Integer |
偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
enterprise_project_id |
否 |
String |
企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,可通过如何获取用户Token获取 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
PageInfo object |
参数 |
参数类型 |
描述 |
---|---|---|
endRow |
Long |
|
hasNextPage |
Boolean |
|
hasPreviousPage |
Boolean |
|
isFirstPage |
Boolean |
|
isLastPage |
Boolean |
|
list |
Array of objects |
|
navigateFirstPage |
Integer |
|
navigateLastPage |
Integer |
|
navigatePages |
Integer |
|
navigatepageNums |
Array of integers |
|
nextPage |
Integer |
|
pageNum |
Integer |
|
pageSize |
Integer |
|
pages |
Integer |
|
prePage |
Integer |
|
size |
Integer |
|
startRow |
Long |
|
total |
Long |
请求示例
查看项目id为eefb11b22d5944f2aa067954516df1cf的EIP告警白名单,防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf,企业项目id为fb55459c-41b3-47fc-885d-540946fddda4。查询结果限制为1000条,偏移量为0。
https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/eip/alarm-whitelist/e743cfaf-8164-4807-aa13-d893d83313cf?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4&limit=1000&offset=0
响应示例
状态码: 200
OK
{ "data" : { "list" : [ { "device_name" : "client_ipv6", "eip_id" : "a40f3306-b7f3-428b-afe7-5ae1e7a5c594", "object_id" : "", "public_ip" : "100.100.100.100", "type" : 1 }, { "device_name" : "ecs-172", "eip_id" : "5e9c7249-2c05-4c0e-a9ed-192af2c1d129", "fw_instance_id" : "e743cfaf-8164-4807-aa13-d893d83313cf", "object_id" : "1b90f031-0c7b-4f25-95e2-b6d9940d269e", "public_ip" : "100.200.200.200", "type" : 0 } ], "pages" : 1, "size" : 2, "total" : 2 } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。