Querying a Data Masking Rule¶

Function Description¶

This API is used to query details about a data masking rule.

URI¶

URI format
GET /v1/{project_id}/waf/policy/{policy_id}/privacy/{privacy_rule_id}

Parameter description

**Table 1** Path parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
policy_id	Yes	String	Specifies the policy ID.
privacy_rule_id	Yes	String	Specifies the ID of a data masking rule.

Request¶

Request parameters

None

Response¶

Response parameters

**Table 2** Parameter description¶
Parameter	Type	Description
id	String	Specifies the ID of a data masking rule.
policy_id	String	Specifies the policy ID.
path	String	Specifies the URL to which the data masking rule applies (exact match by default).
category	String	Specifies the masked field. The options are params and header.
index	String	Specifies the masked subfield.
timestamp	Long	Specifies the time when a data masking rule is added.

Example¶

Rule ID e1c0e55865544d1f8c95cf71df108c6b is used as an example.

Response example

{
  "id": "e1c0e55865544d1f8c95cf71df108c6b",
  "policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
  "path": "/login",
  "category": "params",
  "index": "password",
  "timestamp": 12324435345
}

Status Code¶

Table 3 describes the normal status code returned by the API.

**Table 3** Status code¶
Status Code	Description	Meaning
200	OK	The request has succeeded.

For details about error status codes, see Status Codes.

last updated: 2024-05-04 00:49