Updating the Blacklist or Whitelist
Function
This API is used to update the blacklist or whitelist.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/black-white-list/{list_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
list_id |
Yes |
String |
Blacklist/Whitelist ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
fw_instance_id |
No |
String |
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
direction |
No |
Integer |
Indicates the address direction. 0: source address 1: destination address |
address_type |
No |
Integer |
Address type. 0: ipv4; 1: ipv6; 2: domain |
address |
No |
String |
IP address |
protocol |
No |
Integer |
Protocol type. The value is 6 for TCP, 17 for UDP, 1 for ICMP, 58 for ICMPv6, and -1 for any protocol. |
port |
No |
String |
Port |
list_type |
No |
Integer |
Blacklist/Whitelist type. The options are 4 (blacklist) and 5 (whitelist). Enumeration values:
|
object_id |
No |
String |
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. |
description |
No |
String |
description |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
IdObject object |
Response to the request for updating a blacklist or whitelist |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Description Minimum: 2 Maximum: 512 |
Example Requests
Update the whitelist with the project id 9d80d070b6d44942af73c9c3d38e0429 and the protected object id as cfebd347-b655-4b84-b938-3c54317599b2. The direction is the source address, the address is 1.1.1.1, the protocol type is tcp, and the port is 1 ipv4 tcp
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/9d80d070b6d44942af73c9c3d38e042b { "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", "list_type" : 5, "direction" : 0, "address" : "1.1.1.1", "protocol" : 6, "port" : "1", "address_type" : 0 }
Example Responses
Status code: 200
Blacklist/Whitelist update response
{ "data" : { "id" : "2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a", "name" : "test" } }
Status code: 400
Bad Request
{ "error_code" : "CFW.00200005", "error_msg" : "operation content does not exist" }
SDK Sample Code
The SDK sample code is as follows.
Java
Update the whitelist with the project id 9d80d070b6d44942af73c9c3d38e0429 and the protected object id as cfebd347-b655-4b84-b938-3c54317599b2. The direction is the source address, the address is 1.1.1.1, the protocol type is tcp, and the port is 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 56 |
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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); UpdateBlackWhiteListRequest request = new UpdateBlackWhiteListRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withFwInstanceId("<fw_instance_id>"); UpdateBlackWhiteListDto body = new UpdateBlackWhiteListDto(); body.withObjectId("cfebd347-b655-4b84-b938-3c54317599b2"); body.withListType(UpdateBlackWhiteListDto.ListTypeEnum.NUMBER_5); 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
Update the whitelist with the project id 9d80d070b6d44942af73c9c3d38e0429 and the protected object id as cfebd347-b655-4b84-b938-3c54317599b2. The direction is the source address, the address is 1.1.1.1, the protocol type is tcp, and the port is 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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateBlackWhiteListRequest() request.enterprise_project_id = "<enterprise_project_id>" request.fw_instance_id = "<fw_instance_id>" request.body = UpdateBlackWhiteListDto( object_id="cfebd347-b655-4b84-b938-3c54317599b2", list_type=5, 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
Update the whitelist with the project id 9d80d070b6d44942af73c9c3d38e0429 and the protected object id as cfebd347-b655-4b84-b938-3c54317599b2. The direction is the source address, the address is 1.1.1.1, the protocol type is tcp, and the port is 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 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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateBlackWhiteListRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest fwInstanceIdRequest:= "<fw_instance_id>" request.FwInstanceId = &fwInstanceIdRequest objectIdUpdateBlackWhiteListDto:= "cfebd347-b655-4b84-b938-3c54317599b2" listTypeUpdateBlackWhiteListDto:= model.GetUpdateBlackWhiteListDtoListTypeEnum().E_5 portUpdateBlackWhiteListDto:= "1" protocolUpdateBlackWhiteListDto:= int32(6) addressUpdateBlackWhiteListDto:= "1.1.1.1" addressTypeUpdateBlackWhiteListDto:= int32(0) directionUpdateBlackWhiteListDto:= int32(0) request.Body = &model.UpdateBlackWhiteListDto{ ObjectId: &objectIdUpdateBlackWhiteListDto, ListType: &listTypeUpdateBlackWhiteListDto, Port: &portUpdateBlackWhiteListDto, Protocol: &protocolUpdateBlackWhiteListDto, Address: &addressUpdateBlackWhiteListDto, AddressType: &addressTypeUpdateBlackWhiteListDto, Direction: &directionUpdateBlackWhiteListDto, } response, err := client.UpdateBlackWhiteList(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Blacklist/Whitelist update response |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot