Updating a Blacklist or Whitelist Protection Rule
Function
This API is used to update blacklist and whitelist protection rules. You can update IP addresses, IP address ranges, protective actions, and other information.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Huawei Cloud management cons**. Then, in the Projects area, view Project ID of the corresponding project. |
policy_id |
Yes |
String |
Policy ID. It can be obtained by calling the ListPolicy API. |
rule_id |
Yes |
String |
ID of the blacklist or whitelist rule. It can be obtained by calling the **ListWhiteblackipRule API. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Content-Type |
Yes |
String |
Content type. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Name of the whitelist or blacklist rule. |
addr |
No |
String |
IP address or IP address ranges in the blacklist or whitelist rule, for example, 42.123.120.66 or 42.123.120.0/16. |
description |
No |
String |
Rule description |
white |
Yes |
Integer |
Protective action
|
ip_group_id |
No |
String |
ID of the created IP address group. Use either this parameter or addr. To add an IP address group, go to the WAF console, choose Objects > Address Groups, and click Add Address Group. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID. |
name |
String |
Name of the whitelist or blacklist rule. |
policyid |
String |
Policy ID. |
addr |
String |
IP address or IP address ranges included in the whitelist or blacklist rule. |
description |
String |
Description of the blacklist or whitelist rule. |
white |
Integer |
Protective action
|
time_mode |
String |
The rule application method. Default value: permanent, indicating that the rule will be applied once it is configured. |
ip_group |
Ip_group object |
IP address group |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID of the IP address group. |
name |
String |
Name of the IP address group. |
size |
Long |
Number of IP addresses or IP address ranges in the IP address group. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
The following example shows how to update a whitelist or blacklist protection rule in a policy. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The rule name is changed to demo, protective action to block, description to demo, and blacklist/whitelist IP address to 1.1.1.2.
PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}?enterprise_project_id=0 { "name" : "demo", "white" : 0, "description" : "demo", "addr" : "1.1.1.2" }
Example Responses
Status code: 200
Request succeeded.
{ "id" : "5d43af25404341058d5ab17b7ba78b56", "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d", "name" : "demo", "description" : "demo", "addr" : "1.1.1.2", "white" : 0 }
SDK Sample Code
The SDK sample code is as follows.
The following example shows how to update a whitelist or blacklist protection rule in a policy. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The rule name is changed to demo, protective action to block, description to demo, and blacklist/whitelist IP address to 1.1.1.2.
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.waf.v1.region.WafRegion; import com.huaweicloud.sdk.waf.v1.*; import com.huaweicloud.sdk.waf.v1.model.*; public class UpdateWhiteblackipRuleSolution { 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); WafClient client = WafClient.newBuilder() .withCredential(auth) .withRegion(WafRegion.valueOf("<YOUR REGION>")) .build(); UpdateWhiteblackipRuleRequest request = new UpdateWhiteblackipRuleRequest(); request.withPolicyId("{policy_id}"); request.withRuleId("{rule_id}"); UpdateWhiteBlackIpRuleRequestBody body = new UpdateWhiteBlackIpRuleRequestBody(); body.withWhite(0); body.withDescription("demo"); body.withAddr("1.1.1.2"); body.withName("demo"); request.withBody(body); try { UpdateWhiteblackipRuleResponse response = client.updateWhiteblackipRule(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()); } } } |
The following example shows how to update a whitelist or blacklist protection rule in a policy. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The rule name is changed to demo, protective action to block, description to demo, and blacklist/whitelist IP address to 1.1.1.2.
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 huaweicloudsdkwaf.v1.region.waf_region import WafRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkwaf.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 = WafClient.new_builder() \ .with_credentials(credentials) \ .with_region(WafRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateWhiteblackipRuleRequest() request.policy_id = "{policy_id}" request.rule_id = "{rule_id}" request.body = UpdateWhiteBlackIpRuleRequestBody( white=0, description="demo", addr="1.1.1.2", name="demo" ) response = client.update_whiteblackip_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
The following example shows how to update a whitelist or blacklist protection rule in a policy. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The rule name is changed to demo, protective action to block, description to demo, and blacklist/whitelist IP address to 1.1.1.2.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/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 := waf.NewWafClient( waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateWhiteblackipRuleRequest{} request.PolicyId = "{policy_id}" request.RuleId = "{rule_id}" descriptionUpdateWhiteBlackIpRuleRequestBody:= "demo" addrUpdateWhiteBlackIpRuleRequestBody:= "1.1.1.2" request.Body = &model.UpdateWhiteBlackIpRuleRequestBody{ White: int32(0), Description: &descriptionUpdateWhiteBlackIpRuleRequestBody, Addr: &addrUpdateWhiteBlackIpRuleRequestBody, Name: "demo", } response, err := client.UpdateWhiteblackipRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
Request succeeded. |
400 |
Request failed. |
401 |
The token does not have required permissions. |
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