Batch Updating Precise Protection Rules
Function
This API is used to batch update precise protection rules.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/waf/rule/custom/batch-update
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range The value contains 32 characters. Only letters and digits are supported. Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| enterprise_project_id | No | String | Definition Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps. Constraints N/A Range Default Value 0 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A |
| Content-Type | Yes | String | Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | No | String | Rule name. |
| description | No | String | Rule description. |
| status | No | Integer | Definition Rule status, which is used to specify whether a rule is enabled or disabled. Constraints N/A Range Default Value N/A |
| conditions | No | Array of conditions objects | List of matching conditions. All conditions must be met. |
| action | No | CustomAction object | Protective action of the precise protection rule. |
| action_mode | No | Boolean | Reserved parameter, which can be ignored. |
| priority | No | Integer | Priority of a rule. A small value indicates a high priority. If two rules are assigned with the same priority, the rule added earlier has higher priority. Value range: 0 to 65,535 |
| time | No | Boolean | Time when the precise protection rule takes effect. |
| start | No | Long | Timestamp (s) when the precise protection rule takes effect. This parameter is returned only when time is true. |
| terminal | No | Long | Timestamp (s) when the precise protection rule expires. This parameter is returned only when time is true. |
| producer | No | Integer | Object for creating a rule. This parameter is reserved for future function expansion. Ignore it currently. |
| policy_rule_ids | Yes | Array of policy_rule_ids objects | Definition Array of policy and rule IDs. It associates a protection policy with the corresponding rule set. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| category | No | String | Field type. The options are url, user-agent, ip, params, cookie, referer, header, request_line, method, and request. |
| index | No | String | Subfield: |
| logic_operation | No | String | Condition matching logic. |
| contents | No | Array of strings | Content of the matching condition. |
| value_list_id | No | String | ID of the reference table. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| category | Yes | String | Operation type. |
| followed_action_id | No | String | ID of a known attack source rule. This parameter can be configured only when category is set to block. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| policy_id | Yes | String | Definition Policy ID, which uniquely identifies a protection policy. You can obtain the policy ID by calling the ListPolicy API for querying the list of protection policies. Constraints N/A Range N/A Default Value N/A |
| rule_ids | Yes | Array of strings | Definition Rule ID array, including the ID of a single precise protection rule in the current protection policy. You can obtain the rule ID by calling the API for querying the list of precise protection rules (ListCustomRules). Constraints ID of a single rule. Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| policy_rule_ids | Array of policy_rule_ids objects | Definition Policy and rule ID array. It shows the association between the protection policy and the corresponding rule IDs. Constraints N/A Range N/A Default Value N/A |
| Parameter | Type | Description |
|---|---|---|
| policy_id | String | Definition Policy ID, which uniquely identifies a protection policy. Constraints N/A Range N/A Default Value N/A |
| rule_ids | Array of strings | Definition Rule ID array. IDs of rules in the current protection policy are returned. Constraints N/A Range N/A Default Value N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
| encoded_authorization_message | String | You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
| details | Array of IAM5ErrorDetails objects | The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error codes of the downstream service. |
| error_msg | String | Error messages of the downstream service. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
| encoded_authorization_message | String | You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
| details | Array of IAM5ErrorDetails objects | The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error codes of the downstream service. |
| error_msg | String | Error messages of the downstream service. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
| encoded_authorization_message | String | You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
| details | Array of IAM5ErrorDetails objects | The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Example Requests
Batch update precise protection rules.
POST https://{endpoint}/v1/{project_id}/waf/rule/custom/batch-update?enterprise_project_id=0
{
"name" : "test",
"description" : "",
"action" : {
"category" : "block"
},
"priority" : 50,
"conditions" : [ {
"category" : "header",
"logic_operation" : "contain",
"index" : "demo",
"contents" : [ "demo" ]
} ],
"time" : false,
"policy_rule_ids" : [ {
"rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ],
"policy_id" : "4a34899ab17a4811a6da57742f69135a"
} ]
} Example Responses
Status code: 200
Definition
OK
Constraints
N/A
Range
N/A
Default Value
N/A
{
"policy_rule_ids" : [ {
"rule_ids" : [ "ed37d85a925d469bb01986d06291d15f" ],
"policy_id" : "4a34899ab17a4811a6da57742f69135a"
} ]
} SDK Sample Code
The SDK sample code is as follows.
Batch update precise protection rules.
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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 | 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.*; import java.util.List; import java.util.ArrayList; public class BatchUpdateCustomRulesSolution { 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(); BatchUpdateCustomRulesRequest request = new BatchUpdateCustomRulesRequest(); BatchUpdateCustomRulesRequestBody body = new BatchUpdateCustomRulesRequestBody(); List<String> listPolicyRuleIdsRuleIds = new ArrayList<>(); listPolicyRuleIdsRuleIds.add("ed37d85a925d469bb01986d06291d15f"); List<BatchUpdateCustomRulesRequestBodyPolicyRuleIds> listbodyPolicyRuleIds = new ArrayList<>(); listbodyPolicyRuleIds.add( new BatchUpdateCustomRulesRequestBodyPolicyRuleIds() .withPolicyId("4a34899ab17a4811a6da57742f69135a") .withRuleIds(listPolicyRuleIdsRuleIds) ); CustomAction actionbody = new CustomAction(); actionbody.withCategory(CustomAction.CategoryEnum.fromValue("block")); List<String> listConditionsContents = new ArrayList<>(); listConditionsContents.add("demo"); List<BatchUpdateCustomRulesRequestBodyConditions> listbodyConditions = new ArrayList<>(); listbodyConditions.add( new BatchUpdateCustomRulesRequestBodyConditions() .withCategory("header") .withIndex("demo") .withLogicOperation("contain") .withContents(listConditionsContents) ); body.withPolicyRuleIds(listbodyPolicyRuleIds); body.withTime(false); body.withPriority(50); body.withAction(actionbody); body.withConditions(listbodyConditions); body.withDescription(""); body.withName("test"); request.withBody(body); try { BatchUpdateCustomRulesResponse response = client.batchUpdateCustomRules(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()); } } } |
Batch update precise protection rules.
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 57 58 59 60 61 62 63 | # 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 = BatchUpdateCustomRulesRequest() listRuleIdsPolicyRuleIds = [ "ed37d85a925d469bb01986d06291d15f" ] listPolicyRuleIdsbody = [ BatchUpdateCustomRulesRequestBodyPolicyRuleIds( policy_id="4a34899ab17a4811a6da57742f69135a", rule_ids=listRuleIdsPolicyRuleIds ) ] actionbody = CustomAction( category="block" ) listContentsConditions = [ "demo" ] listConditionsbody = [ BatchUpdateCustomRulesRequestBodyConditions( category="header", index="demo", logic_operation="contain", contents=listContentsConditions ) ] request.body = BatchUpdateCustomRulesRequestBody( policy_rule_ids=listPolicyRuleIdsbody, time=False, priority=50, action=actionbody, conditions=listConditionsbody, description="", name="test" ) response = client.batch_update_custom_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Batch update precise protection rules.
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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := waf.NewWafClient(hcClient) request := &model.BatchUpdateCustomRulesRequest{} var listRuleIdsPolicyRuleIds = []string{ "ed37d85a925d469bb01986d06291d15f", } var listPolicyRuleIdsbody = []model.BatchUpdateCustomRulesRequestBodyPolicyRuleIds{ { PolicyId: "4a34899ab17a4811a6da57742f69135a", RuleIds: listRuleIdsPolicyRuleIds, }, } actionbody := &model.CustomAction{ Category: model.GetCustomActionCategoryEnum().BLOCK, } var listContentsConditions = []string{ "demo", } categoryConditions:= "header" indexConditions:= "demo" logicOperationConditions:= "contain" var listConditionsbody = []model.BatchUpdateCustomRulesRequestBodyConditions{ { Category: &categoryConditions, Index: &indexConditions, LogicOperation: &logicOperationConditions, Contents: &listContentsConditions, }, } timeBatchUpdateCustomRulesRequestBody:= false priorityBatchUpdateCustomRulesRequestBody:= int32(50) descriptionBatchUpdateCustomRulesRequestBody:= "" nameBatchUpdateCustomRulesRequestBody:= "test" request.Body = &model.BatchUpdateCustomRulesRequestBody{ PolicyRuleIds: listPolicyRuleIdsbody, Time: &timeBatchUpdateCustomRulesRequestBody, Priority: &priorityBatchUpdateCustomRulesRequestBody, Action: actionbody, Conditions: &listConditionsbody, Description: &descriptionBatchUpdateCustomRulesRequestBody, Name: &nameBatchUpdateCustomRulesRequestBody, } response, err := client.BatchUpdateCustomRules(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 | Definition OK Constraints N/A Range N/A Default Value N/A |
| 400 | Definition Request failed. Constraints N/A Range N/A Default Value N/A |
| 401 | Definition The token does not have required permissions. Constraints N/A Range N/A Default Value N/A |
| 500 | Definition Internal server error. Constraints N/A Range N/A Default Value N/A |
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