# 导入IP黑名单用于流量过滤 - ImportIpBlacklist #### 功能介绍 此接口用来导入IP黑名单，IP列表保存在request的body中，IP列表支持的格式如下： 单个IP地址，例如：100.1.1.10 连续的IP地址段，例如：80.1.1.3-80.1.1.30 掩码格式的网段，例如：6.6.6.0/24 #### 调用方法 请参见[如何调用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}/ptf/ip-blacklist/import 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，可以通过调用API获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html) | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | fw_instance_id | 是 | String | 防火墙ID，可通过[防火墙ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0028.html)获取 | #### 请求参数 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | add_type | 否 | Integer | IP黑名单导入的方式，0表示增量导入，在原来的基础上追加；1表示全量导入，新导入的IP黑名单会覆盖已有的IP黑名单 | | ip_blacklist | 否 | String | IP列表，当前支持不同的IP地址之间使用"," 、" "、";"、"\\n"、"\\n"、"\\t"等分割符进行分割。 | | effect_scope | 否 | Array of integers | 生效范围，1表示生效范围为eip, 2表示生效范围为nat, \[1 2\]表示 生效范围为eip和nat | #### 响应参数 **状态码：200** OK 无 #### 请求示例 全量方式导入一个IP黑名单，项目id为eefb11b22d5944f2aa067954516df1cf，防护对象 id为812f478c-940e-4e00-824f-7287250d76dc， 生效范围为EIP，IP列表为"100.1.1.10\\n80.1.1.3-80.1.1.30\\n6.6.6.0/24\\n2001:db8::2-2001:db8::200\\n3001:db8::2\\n4001:db8::2/64"， v4格式和v6格式的ip可以一起导入，ip之间使用\\n分割。 ``` https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/ptf/ip-blacklist/import?fw_instance_id=812f478c-940e-4e00-824f-7287250d76dc { "add_type" : 1, "ip_blacklist" : "100.1.1.10\\n80.1.1.3-80.1.1.30\\n6.6.6.0/24\\n2001:db8::2-2001:db8::200\\n3001:db8::2\\n4001:db8::2/64", "effect_scope" : [ 1 ] } ``` #### 响应示例 **状态码：200** OK ``` { "data" : { } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 全量方式导入一个IP黑名单，项目id为eefb11b22d5944f2aa067954516df1cf，防护对象 id为812f478c-940e-4e00-824f-7287250d76dc， 生效范围为EIP，IP列表为"100.1.1.10\\n80.1.1.3-80.1.1.30\\n6.6.6.0/24\\n2001:db8::2-2001:db8::200\\n3001:db8::2\\n4001:db8::2/64"， v4格式和v6格式的ip可以一起导入，ip之间使用\\n分割。 ``` 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 ImportIpBlacklistSolution { 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(); ImportIpBlacklistRequest request = new ImportIpBlacklistRequest(); IpBlacklistImportDto body = new IpBlacklistImportDto(); List listbodyEffectScope = new ArrayList<>(); listbodyEffectScope.add(1); body.withEffectScope(listbodyEffectScope); body.withIpBlacklist("100.1.1.10\n80.1.1.3-80.1.1.30\n6.6.6.0/24\n2001:db8::2-2001:db8::200\n3001:db8::2\n4001:db8::2/64"); body.withAddType(1); request.withBody(body); try { ImportIpBlacklistResponse response = client.importIpBlacklist(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] 全量方式导入一个IP黑名单，项目id为eefb11b22d5944f2aa067954516df1cf，防护对象 id为812f478c-940e-4e00-824f-7287250d76dc， 生效范围为EIP，IP列表为"100.1.1.10\\n80.1.1.3-80.1.1.30\\n6.6.6.0/24\\n2001:db8::2-2001:db8::200\\n3001:db8::2\\n4001:db8::2/64"， v4格式和v6格式的ip可以一起导入，ip之间使用\\n分割。 ``` # 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 = ImportIpBlacklistRequest() listEffectScopebody = [ 1 ] request.body = IpBlacklistImportDto( effect_scope=listEffectScopebody, ip_blacklist="100.1.1.10\n80.1.1.3-80.1.1.30\n6.6.6.0/24\n2001:db8::2-2001:db8::200\n3001:db8::2\n4001:db8::2/64", add_type=1 ) response = client.import_ip_blacklist(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] 全量方式导入一个IP黑名单，项目id为eefb11b22d5944f2aa067954516df1cf，防护对象 id为812f478c-940e-4e00-824f-7287250d76dc， 生效范围为EIP，IP列表为"100.1.1.10\\n80.1.1.3-80.1.1.30\\n6.6.6.0/24\\n2001:db8::2-2001:db8::200\\n3001:db8::2\\n4001:db8::2/64"， v4格式和v6格式的ip可以一起导入，ip之间使用\\n分割。 ``` 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.ImportIpBlacklistRequest{} var listEffectScopebody = []int32{ int32(1), } ipBlacklistIpBlacklistImportDto:= "100.1.1.10\n80.1.1.3-80.1.1.30\n6.6.6.0/24\n2001:db8::2-2001:db8::200\n3001:db8::2\n4001:db8::2/64" addTypeIpBlacklistImportDto:= int32(1) request.Body = &model.IpBlacklistImportDto{ EffectScope: &listEffectScopebody, IpBlacklist: &ipBlacklistIpBlacklistImportDto, AddType: &addTypeIpBlacklistImportDto, } response, err := client.ImportIpBlacklist(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=ImportIpBlacklist)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 401 | 鉴权认证失败 | | 403 | 不允许操作 | | 500 | 内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cfw/ErrorCode.html)。