Creating a precise protection rule
Function
This API is used to create a precise protection rule.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/waf/policy/{policy_id}/custom
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Huawei Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials. Then, in the Projects area, view Project ID of the corresponding project. |
policy_id |
Yes |
String |
ID of a protection policy. You can specify a protection policy ID to query the rules used in the protection policy. You can obtain the policy ID by calling the ListPolicy 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 |
---|---|---|---|
time |
Yes |
Boolean |
Time the precise protection rule takes effect.
|
start |
No |
Long |
Timestamp (ms) when the precise protection rule takes effect. This parameter is mandatory only when time is set to true. |
terminal |
No |
Long |
Timestamp (ms) when the precise protection rule expires. This parameter is mandatory only when time is set to true. |
description |
No |
String |
Rule description. |
conditions |
Yes |
Array of CustomConditions objects |
Match condition List |
action |
Yes |
CustomAction object |
Protective action of the precise protection rule. |
priority |
Yes |
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 1000. |
name |
Yes |
String |
Rule name. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
category |
No |
String |
Field type. The options can be url, user-agent, ip, params, cookie, referer, header, request_line, method, or request. |
index |
No |
String |
Subfield type.
|
logic_operation |
No |
String |
Logic for matching the condition. The options are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, and not_suffix. For more details, see the console UI. |
contents |
No |
Array of strings |
Content of the conditions. This parameter is mandatory when the suffix of logic_operation is not any or all. |
value_list_id |
No |
String |
Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is mandatory when the suffix of logic_operation is any or all. The reference table type must be the same as the category type. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
category |
Yes |
String |
Protection 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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID. |
name |
String |
Rule name. |
policyid |
String |
Policy ID. |
description |
String |
Rule description. |
status |
Integer |
Rule status. The value can be 0 or 1.
|
conditions |
Array of conditions objects |
List of matching conditions. All conditions must be met. |
action |
CustomAction object |
Protective action of the precise protection rule. |
action_mode |
Boolean |
This parameter is reserved and can be ignored. |
priority |
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 1000. |
timestamp |
Long |
Timestamp when the precise protection rule is created. |
time |
Boolean |
Time the precise protection rule takes effect.
|
start |
Long |
Timestamp (ms) when the precise protection rule takes effect. This parameter is returned only when time is set to true. |
terminal |
Long |
Timestamp (ms) when the precise protection rule expires. This parameter is returned only when time is set to true. |
producer |
Integer |
This parameter is reserved and can be ignored. |
Parameter |
Type |
Description |
---|---|---|
category |
String |
Field type. The options are url, user-agent, ip, params, cookie, referer, header, request_line, method, and request. |
index |
String |
Subfield
|
logic_operation |
String |
Logic for matching the condition. |
contents |
Array of strings |
Content of the conditions. |
value_list_id |
String |
Reference table ID. |
Parameter |
Type |
Description |
---|---|---|
category |
String |
Protection type
|
followed_action_id |
String |
ID of a known attack source rule. This parameter can be configured only when category is set to block. |
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
The following example shows how to create a precise protection rule. Details about the query are specified by project_id and policy_id. The rule name is test55. The protective action is Block. The priority for executing the rule is 50. The matching condition is that the demo field in the header contains demo. The rule takes effect immediately.
POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/custom?enterprise_project_id=0 { "name" : "test55", "description" : "", "action" : { "category" : "block" }, "priority" : 50, "conditions" : [ { "category" : "header", "logic_operation" : "contain", "index" : "demo", "contents" : [ "demo" ] } ], "time" : false }
Example Responses
Status code: 200
ok
{ "action" : { "category" : "block" }, "action_mode" : false, "conditions" : [ { "category" : "header", "index" : "demo", "logic_operation" : "contain", "contents" : [ "demo" ] } ], "description" : "", "name" : "test55", "id" : "2a3caa2bc9814c09ad73d02e3485b4a4", "policyid" : "1f016cde588646aca3fb19f277c44d03", "priority" : 50, "status" : 1, "time" : false, "timestamp" : 1656495488880 }
SDK Sample Code
The SDK sample code is as follows.
The following example shows how to create a precise protection rule. Details about the query are specified by project_id and policy_id. The rule name is test55. The protective action is Block. The priority for executing the rule is 50. The matching condition is that the demo field in the header contains demo. The rule takes effect immediately.
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 |
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 CreateCustomRuleSolution { 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(); CreateCustomRuleRequest request = new CreateCustomRuleRequest(); request.withPolicyId("{policy_id}"); CreateCustomRuleRequestBody body = new CreateCustomRuleRequestBody(); CustomAction actionbody = new CustomAction(); actionbody.withCategory(CustomAction.CategoryEnum.fromValue("block")); List<String> listConditionsContents = new ArrayList<>(); listConditionsContents.add("demo"); List<CustomConditions> listbodyConditions = new ArrayList<>(); listbodyConditions.add( new CustomConditions() .withCategory(CustomConditions.CategoryEnum.fromValue("header")) .withIndex("demo") .withLogicOperation("contain") .withContents(listConditionsContents) ); body.withName("test55"); body.withPriority(50); body.withAction(actionbody); body.withConditions(listbodyConditions); body.withDescription(""); body.withTime(false); request.withBody(body); try { CreateCustomRuleResponse response = client.createCustomRule(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 create a precise protection rule. Details about the query are specified by project_id and policy_id. The rule name is test55. The protective action is Block. The priority for executing the rule is 50. The matching condition is that the demo field in the header contains demo. The rule takes effect immediately.
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 |
# 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 = CreateCustomRuleRequest() request.policy_id = "{policy_id}" actionbody = CustomAction( category="block" ) listContentsConditions = [ "demo" ] listConditionsbody = [ CustomConditions( category="header", index="demo", logic_operation="contain", contents=listContentsConditions ) ] request.body = CreateCustomRuleRequestBody( name="test55", priority=50, action=actionbody, conditions=listConditionsbody, description="", time=False ) response = client.create_custom_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 create a precise protection rule. Details about the query are specified by project_id and policy_id. The rule name is test55. The protective action is Block. The priority for executing the rule is 50. The matching condition is that the demo field in the header contains demo. The rule takes effect immediately.
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 |
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.CreateCustomRuleRequest{} request.PolicyId = "{policy_id}" actionbody := &model.CustomAction{ Category: model.GetCustomActionCategoryEnum().BLOCK, } var listContentsConditions = []string{ "demo", } categoryConditions:= model.GetCustomConditionsCategoryEnum().HEADER indexConditions:= "demo" logicOperationConditions:= "contain" var listConditionsbody = []model.CustomConditions{ { Category: &categoryConditions, Index: &indexConditions, LogicOperation: &logicOperationConditions, Contents: &listContentsConditions, }, } descriptionCreateCustomRuleRequestBody:= "" request.Body = &model.CreateCustomRuleRequestBody{ Name: "test55", Priority: int32(50), Action: actionbody, Conditions: listConditionsbody, Description: &descriptionCreateCustomRuleRequestBody, Time: false, } response, err := client.CreateCustomRule(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 |
ok |
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