添加EIP告警白名单
功能介绍
添加EIP告警白名单
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/eip/alarm-whitelist
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
eip_infos |
否 |
Array of EipInfo objects |
参数解释: EIP详情 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
fw_instance_id |
是 |
String |
参数解释: 防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
eip_id |
否 |
String |
参数解释: 弹性公网ID,可通过调用弹性IP列表查询获取,通过返回值中的data.records.id(.表示各对象之间层级的区分)获得 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
fw_instance_id |
否 |
String |
参数解释: 防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
object_id |
否 |
String |
参数解释: 防护对象ID,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志ID,可通过调用查询防火墙实例接口获得,通过返回值中的data.records.protect_objects.object_id(.表示各对象之间层级的区分)获得,注意type为0的为互联网边界防护对象ID,type为1的为VPC边界防护对象ID。 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
public_ip |
否 |
String |
参数解释: IPV4地址 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
public_ipv6 |
否 |
String |
参数解释: IPV6地址 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
Object |
参数解释: 添加EIP告警白名单响应data 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 防火墙实例id 约束限制: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
添加告警白名单,项目id为28f403ddd3f141daa6e046e85cb15519
https://{Endpoint}/v1/28f403ddd3f141daa6e046e85cb15519/eip/alarm-whitelist { "eip_infos" : [ { "eip_id" : "10d42cba-5f7d-40c5-bf69-07685ddfa17a", "object_id" : "b6d7a4f8-796d-424b-8bc6-c7ba22a7a1b1", "public_ip" : "124.71.185.245", "type" : 0 }, { "eip_id" : "2720563d-a547-4542-8855-87f967c5be00", "object_id" : "ee4c6f1c-2ee1-45d2-b276-0a41c1180035", "public_ip" : "1.94.54.125", "type" : 0 } ], "fw_instance_id" : "0cf6f7a8-a062-455c-a5ac-1f2af9272af6" }
响应示例
状态码:200
OK
{ "data" : { "id" : "0cf6f7a8-a062-455c-a5ac-1f2af9272af6" } }
状态码:400
Bad Request
{ "error_code" : "CFW.00200003", "error_msg" : "参数错误" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。