Creating a Data Masking Rule
Function
This API is used to create a data masking rule.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/waf/policy/{policy_id}/privacy
| 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 N/A Default Value N/A |
| 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 |
| 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 |
|---|---|---|---|
| url | Yes | String | Definition URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin/xxx or /admin/*. The characters * indicate a wildcard, which is used to match all sub-paths under the path prefix. For example, if you have a path prefix /admin/, it will match all URL paths starting with /admin/. If the URL parameter is set to /admin/*, all URL paths starting with /admin/ will match the rule. Constraints Standard URL string or URL prefix string for matching Range N/A Default Value N/A |
| category | Yes | String | Definition Masked field. Constraints N/A Range Default Value N/A |
| index | Yes | String | Definition Masked field. A masked field will not be displayed in logs. Constraints The length cannot exceed 2048 bytes. Range N/A Default Value N/A |
| description | No | String | (Optional) A description of the rule. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| id | String | Rule ID. |
| policyid | String | Policy ID. |
| timestamp | Long | Time the rule was created. The value is a 13-digit timestamp in ms. |
| status | Integer | Definition Rule status, which is used to specify whether a rule is enabled or disabled. Constraints N/A Range Default Value N/A |
| url | String | URL protected by the data masking rule. The value must be in the standard URL format, for example, /admin/xxx or /admin/*. The combination of the backslash () and asterisk (*) indicates the path prefix. |
| category | String | Definition Masked field. Constraints N/A Range Default Value N/A |
| index | String | Masked field name. Set the field name based on the masked field. The masked field will not be displayed in logs. |
| description | String | (Optional) A description of the rule. |
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 data masking rule in a policy. The project ID is specified by project_id and the policy ID is specified by policy_id. The url of the rule is /demo, the masking field is cookie, the masking field name is demo, and the rule description is demo.
POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/privacy?enterprise_project_id=0
{
"url" : "/demo",
"category" : "cookie",
"index" : "demo",
"description" : "demo"
} Example Responses
Status code: 200
Request succeeded.
{
"id" : "97e4d35f375f4736a21cccfad77613eb",
"policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
"timestamp" : 1650533191385,
"description" : "demo",
"status" : 1,
"url" : "/demo",
"category" : "cookie",
"index" : "demo"
} SDK Sample Code
The SDK sample code is as follows.
The following example shows how to create a data masking rule in a policy. The project ID is specified by project_id and the policy ID is specified by policy_id. The url of the rule is /demo, the masking field is cookie, the masking field name is demo, and the rule description is demo.
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 | 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 CreatePrivacyRuleSolution { 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(); CreatePrivacyRuleRequest request = new CreatePrivacyRuleRequest(); request.withPolicyId("{policy_id}"); CreatePrivacyRuleRequestBody body = new CreatePrivacyRuleRequestBody(); body.withDescription("demo"); body.withIndex("demo"); body.withCategory(CreatePrivacyRuleRequestBody.CategoryEnum.fromValue("cookie")); body.withUrl("/demo"); request.withBody(body); try { CreatePrivacyRuleResponse response = client.createPrivacyRule(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 data masking rule in a policy. The project ID is specified by project_id and the policy ID is specified by policy_id. The url of the rule is /demo, the masking field is cookie, the masking field name is demo, and the rule description is demo.
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 | # 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 = CreatePrivacyRuleRequest() request.policy_id = "{policy_id}" request.body = CreatePrivacyRuleRequestBody( description="demo", index="demo", category="cookie", url="/demo" ) response = client.create_privacy_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 data masking rule in a policy. The project ID is specified by project_id and the policy ID is specified by policy_id. The url of the rule is /demo, the masking field is cookie, the masking field name is demo, and the rule description is demo.
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 | 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.CreatePrivacyRuleRequest{} request.PolicyId = "{policy_id}" descriptionCreatePrivacyRuleRequestBody:= "demo" request.Body = &model.CreatePrivacyRuleRequestBody{ Description: &descriptionCreatePrivacyRuleRequestBody, Index: "demo", Category: model.GetCreatePrivacyRuleRequestBodyCategoryEnum().COOKIE, Url: "/demo", } response, err := client.CreatePrivacyRule(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