更新黑白名单列表
功能介绍
更新黑白名单列表
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/black-white-list/{list_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式 |
list_id |
是 |
String |
黑白名单列表id,可通过查询黑白名单列表接口查询获得,通过返回值中的data.records.list_id(.表示各对象之间层级的区分)获得。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 |
fw_instance_id |
否 |
String |
防火墙id,可通过防火墙ID获取方式获取 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。可通过如何获取用户Token获取。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
direction |
否 |
Integer |
地址方向0:源地址1:目的地址 |
address_type |
否 |
Integer |
地址类型0:ipv4,1:ipv6 |
address |
是 |
String |
ip地址 |
protocol |
否 |
Integer |
协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1 |
port |
否 |
String |
端口 |
description |
否 |
String |
描述 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
BlackWhiteListId object |
更新黑白名单响应数据 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
更新项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的白名单为方向为源地址,地址为1.1.1.1,协议类型为tcp,端口为1的ipv4的tcp
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/9d80d070b6d44942af73c9c3d38e042b { "direction" : 0, "address" : "1.1.1.1", "protocol" : 6, "port" : "1", "address_type" : 0 }
响应示例
状态码: 200
更新黑白名单响应
{ "data" : { "id" : "5d37afe6-c5b4-400d-8ff3-a8d6396d7ace", "name" : "10.1.1.10" } }
状态码: 400
Bad Request
{ "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }
SDK代码示例
SDK代码示例如下。
Java
更新项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的白名单为方向为源地址,地址为1.1.1.1,协议类型为tcp,端口为1的ipv4的tcp
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
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.*; public class UpdateBlackWhiteListSolution { 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("<YOUR REGION>")) .build(); UpdateBlackWhiteListRequest request = new UpdateBlackWhiteListRequest(); request.withListId("{list_id}"); UpdateBlackWhiteListDto body = new UpdateBlackWhiteListDto(); body.withPort("1"); body.withProtocol(6); body.withAddress("1.1.1.1"); body.withAddressType(0); body.withDirection(0); request.withBody(body); try { UpdateBlackWhiteListResponse response = client.updateBlackWhiteList(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为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的白名单为方向为源地址,地址为1.1.1.1,协议类型为tcp,端口为1的ipv4的tcp
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# 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("<YOUR REGION>")) \ .build() try: request = UpdateBlackWhiteListRequest() request.list_id = "{list_id}" request.body = UpdateBlackWhiteListDto( port="1", protocol=6, address="1.1.1.1", address_type=0, direction=0 ) response = client.update_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为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的白名单为方向为源地址,地址为1.1.1.1,协议类型为tcp,端口为1的ipv4的tcp
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateBlackWhiteListRequest{} request.ListId = "{list_id}" portUpdateBlackWhiteListDto:= "1" protocolUpdateBlackWhiteListDto:= int32(6) addressTypeUpdateBlackWhiteListDto:= int32(0) directionUpdateBlackWhiteListDto:= int32(0) request.Body = &model.UpdateBlackWhiteListDto{ Port: &portUpdateBlackWhiteListDto, Protocol: &protocolUpdateBlackWhiteListDto, Address: "1.1.1.1", AddressType: &addressTypeUpdateBlackWhiteListDto, Direction: &directionUpdateBlackWhiteListDto, } response, err := client.UpdateBlackWhiteList(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
更新黑白名单响应 |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。