# 添加EIP告警白名单 - AddEipAlarmWhitelist #### 功能介绍 添加EIP告警白名单 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cfw/cfw_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cfw/cfw_02_0018.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v1/{project_id}/eip/alarm-whitelist 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html) **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | eip_infos | 否 | Array of [EipInfo] objects | **参数解释**： EIP详情 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | fw_instance_id | 是 | String | **参数解释**： 防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过[防火墙ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0028.html)获取 **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | 表3EipInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | eip_id | 否 | String | **参数解释**： 弹性公网ID，可通过调用弹性IP列表查询获取，通过返回值中的data.records.id（.表示各对象之间层级的区分）获得 **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | | fw_instance_id | 否 | String | **参数解释**： 防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过[防火墙ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0028.html)获取 **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | | object_id | 否 | String | **参数解释**： 防护对象ID，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志ID，可通过调用[查询防火墙实例接口](https://support.huaweicloud.com/api-cfw/ListFirewallDetail.html)获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象ID，type为1的为VPC边界防护对象ID。 **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | | public_ip | 否 | String | **参数解释**： IPV4地址 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | public_ipv6 | 否 | String | **参数解释**： IPV6地址 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | type | 否 | Integer | **参数解释**： EIP白名单标志，表示该EIP是否已开启告警白名单防护 **约束限制**： 不涉及 **取值范围**： 0：未开启 1：已开启 **默认取值**： 0 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [AddEipAlarmWhitelistRespData] object | | 表5AddEipAlarmWhitelistRespData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 防火墙实例id | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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" : "参数错误" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 添加告警白名单，项目id为28f403ddd3f141daa6e046e85cb15519 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; import java.util.List; import java.util.ArrayList; public class AddEipAlarmWhitelistSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("")) .build(); AddEipAlarmWhitelistRequest request = new AddEipAlarmWhitelistRequest(); AddEipAlarmWhitelistRequestBody body = new AddEipAlarmWhitelistRequestBody(); List listbodyEipInfos = new ArrayList<>(); listbodyEipInfos.add( new EipInfo() .withEipId("10d42cba-5f7d-40c5-bf69-07685ddfa17a") .withObjectId("b6d7a4f8-796d-424b-8bc6-c7ba22a7a1b1") .withPublicIp("124.71.185.245") .withType(0) ); listbodyEipInfos.add( new EipInfo() .withEipId("2720563d-a547-4542-8855-87f967c5be00") .withObjectId("ee4c6f1c-2ee1-45d2-b276-0a41c1180035") .withPublicIp("1.94.54.125") .withType(0) ); body.withFwInstanceId("0cf6f7a8-a062-455c-a5ac-1f2af9272af6"); body.withEipInfos(listbodyEipInfos); request.withBody(body); try { AddEipAlarmWhitelistResponse response = client.addEipAlarmWhitelist(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 添加告警白名单，项目id为28f403ddd3f141daa6e046e85cb15519 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("")) \ .build() try: request = AddEipAlarmWhitelistRequest() listEipInfosbody = [ EipInfo( eip_id="10d42cba-5f7d-40c5-bf69-07685ddfa17a", object_id="b6d7a4f8-796d-424b-8bc6-c7ba22a7a1b1", public_ip="124.71.185.245", type=0 ), EipInfo( eip_id="2720563d-a547-4542-8855-87f967c5be00", object_id="ee4c6f1c-2ee1-45d2-b276-0a41c1180035", public_ip="1.94.54.125", type=0 ) ] request.body = AddEipAlarmWhitelistRequestBody( fw_instance_id="0cf6f7a8-a062-455c-a5ac-1f2af9272af6", eip_infos=listEipInfosbody ) response = client.add_eip_alarm_whitelist(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 添加告警白名单，项目id为28f403ddd3f141daa6e046e85cb15519 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cfw.CfwClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cfw.NewCfwClient(hcClient) request := &model.AddEipAlarmWhitelistRequest{} eipIdEipInfos:= "10d42cba-5f7d-40c5-bf69-07685ddfa17a" objectIdEipInfos:= "b6d7a4f8-796d-424b-8bc6-c7ba22a7a1b1" publicIpEipInfos:= "124.71.185.245" typeEipInfos:= int32(0) eipIdEipInfos1:= "2720563d-a547-4542-8855-87f967c5be00" objectIdEipInfos1:= "ee4c6f1c-2ee1-45d2-b276-0a41c1180035" publicIpEipInfos1:= "1.94.54.125" typeEipInfos1:= int32(0) var listEipInfosbody = []model.EipInfo{ { EipId: &eipIdEipInfos, ObjectId: &objectIdEipInfos, PublicIp: &publicIpEipInfos, Type: &typeEipInfos, }, { EipId: &eipIdEipInfos1, ObjectId: &objectIdEipInfos1, PublicIp: &publicIpEipInfos1, Type: &typeEipInfos1, }, } request.Body = &model.AddEipAlarmWhitelistRequestBody{ FwInstanceId: "0cf6f7a8-a062-455c-a5ac-1f2af9272af6", EipInfos: &listEipInfosbody, } response, err := client.AddEipAlarmWhitelist(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CFW/sdk?api=AddEipAlarmWhitelist)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cfw/ErrorCode.html)。