# 批量添加黑白名单列表 - BatchCreateBlackWhiteList #### 功能介绍 批量添加黑白名单列表 #### 调用方法 请参见[如何调用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}/black-white-lists 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html) **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | list_items | 是 | Array of [BlackWhiteInfo] objects | **参数解释**： 黑白名单信息列表 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | list_type | 是 | Integer | **参数解释**： 黑白名单列表类型 **约束限制**： 不涉及 **取值范围**： 4：黑名单 5：白名单 **默认取值**： 不涉及 | | object_id | 是 | String | **参数解释**： 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，type为0时，object_id为互联网边界防护对象ID，type为1时，object_id为VPC边界防护对象ID，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表3BlackWhiteInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | address | 是 | String | **参数解释**： IP地址 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | address_type | 否 | Integer | **参数解释**： IP地址类型 **约束限制**： 不涉及 **取值范围**： 0：IPV4 1：IPV6 **默认取值**： 不涉及 | | description | 否 | String | **参数解释**： 描述 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | direction | 是 | Integer | **参数解释**： 地址方向 **约束限制**： 不涉及 **取值范围**： 0：源地址 1：目的地址 **默认取值**： 不涉及 | | port | 否 | String | **参数解释**： 端口 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | protocol | 是 | Integer | **参数解释**： 协议类型 **约束限制**： 不涉及 **取值范围**： -1：ANY 1：ICMP 6：TCP 17：UDP 58：ICMPV6 132：SCTP 手动类型不为空，自动类型为空 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [AddBlackWhiteListBatchVO] object | | 表5AddBlackWhiteListBatchVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | duplicated_list | Array of [BlackWhiteInfo] objects | **参数解释**： 黑白名单重复添加列表 **取值范围**： 不涉及 | | failed_list | Array of [BlackWhiteInfo] objects | **参数解释**： 黑白名单添加失败列表 **取值范围**： 不涉及 | | success_list | Array of [BlackWhiteInfo] objects | **参数解释**： 黑白名单添加成功列表 **取值范围**： 不涉及 | 表6BlackWhiteInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | address | String | **参数解释**： IP地址 **取值范围**： 不涉及 | | address_type | Integer | **参数解释**： IP地址类型 **取值范围**： 0：IPV4 1：IPV6 | | description | String | **参数解释**： 描述 **取值范围**： 不涉及 | | direction | Integer | **参数解释**： 地址方向 **取值范围**： 0：源地址 1：目的地址 | | port | String | **参数解释**： 端口 **取值范围**： 不涉及 | | protocol | Integer | **参数解释**： 协议类型 **取值范围**： -1：ANY 1：ICMP 6：TCP 17：UDP 58：ICMPV6 132：SCTP 手动类型不为空，自动类型为空 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述 **取值范围**： 不涉及 | #### 请求示例 批量添加黑名单列表，项目id为5de88e3e18124fa99675fb51ceceaa31，将ip地址1.2.3.4、2.3.4.5、3.4.5.6添加进黑名单 ``` https://{Endpoint}/v1/5de88e3e18124fa99675fb51ceceaa31/black-white-lists { "object_id" : "c5bee3c1-63aa-405f-8a38-8bac2b5674e1", "list_type" : 4, "list_items" : [ { "address" : "1.2.3.4", "direction" : 0, "protocol" : -1 }, { "address" : "2.3.4.5", "direction" : 0, "protocol" : -1 }, { "address" : "3.4.5.6", "direction" : 0, "protocol" : -1 } ] } ``` #### 响应示例 **状态码：200** OK ``` { "data" : { "duplicated_list" : [ ], "failed_list" : [ ], "success_list" : [ { "address" : "1.2.3.4", "address_type" : 0, "direction" : 0, "port" : "1-65535", "protocol" : -1 }, { "address" : "2.3.4.5", "address_type" : 0, "direction" : 0, "port" : "1-65535", "protocol" : -1 }, { "address" : "3.4.5.6", "address_type" : 0, "direction" : 0, "port" : "1-65535", "protocol" : -1 } ] } } ``` **状态码：400** Bad Request ``` { "error_code" : "CFW.00200003", "error_msg" : "参数错误" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 批量添加黑名单列表，项目id为5de88e3e18124fa99675fb51ceceaa31，将ip地址1.2.3.4、2.3.4.5、3.4.5.6添加进黑名单 ``` 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 BatchCreateBlackWhiteListSolution { 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(); BatchCreateBlackWhiteListRequest request = new BatchCreateBlackWhiteListRequest(); AddBlackWhiteBatchDto body = new AddBlackWhiteBatchDto(); List listbodyListItems = new ArrayList<>(); listbodyListItems.add( new BlackWhiteInfo() .withAddress("1.2.3.4") .withDirection(0) .withProtocol(BlackWhiteInfo.ProtocolEnum.NUMBER_-1) ); listbodyListItems.add( new BlackWhiteInfo() .withAddress("2.3.4.5") .withDirection(0) .withProtocol(BlackWhiteInfo.ProtocolEnum.NUMBER_-1) ); listbodyListItems.add( new BlackWhiteInfo() .withAddress("3.4.5.6") .withDirection(0) .withProtocol(BlackWhiteInfo.ProtocolEnum.NUMBER_-1) ); body.withObjectId("c5bee3c1-63aa-405f-8a38-8bac2b5674e1"); body.withListType(4); body.withListItems(listbodyListItems); request.withBody(body); try { BatchCreateBlackWhiteListResponse response = client.batchCreateBlackWhiteList(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为5de88e3e18124fa99675fb51ceceaa31，将ip地址1.2.3.4、2.3.4.5、3.4.5.6添加进黑名单 ``` # 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 = BatchCreateBlackWhiteListRequest() listListItemsbody = [ BlackWhiteInfo( address="1.2.3.4", direction=0, protocol=-1 ), BlackWhiteInfo( address="2.3.4.5", direction=0, protocol=-1 ), BlackWhiteInfo( address="3.4.5.6", direction=0, protocol=-1 ) ] request.body = AddBlackWhiteBatchDto( object_id="c5bee3c1-63aa-405f-8a38-8bac2b5674e1", list_type=4, list_items=listListItemsbody ) response = client.batch_create_black_white_list(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为5de88e3e18124fa99675fb51ceceaa31，将ip地址1.2.3.4、2.3.4.5、3.4.5.6添加进黑名单 ``` 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.BatchCreateBlackWhiteListRequest{} var listListItemsbody = []model.BlackWhiteInfo{ { Address: "1.2.3.4", Direction: int32(0), Protocol: model.GetBlackWhiteInfoProtocolEnum().E_1, }, { Address: "2.3.4.5", Direction: int32(0), Protocol: model.GetBlackWhiteInfoProtocolEnum().E_1, }, { Address: "3.4.5.6", Direction: int32(0), Protocol: model.GetBlackWhiteInfoProtocolEnum().E_1, }, } request.Body = &model.AddBlackWhiteBatchDto{ ObjectId: "c5bee3c1-63aa-405f-8a38-8bac2b5674e1", ListType: int32(4), ListItems: listListItemsbody, } response, err := client.BatchCreateBlackWhiteList(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=BatchCreateBlackWhiteList)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cfw/ErrorCode.html)。