Querying Data Masking Rules

Function

This API is used to query data masking rules.

URI

GET /v1/{project_id}/waf/policy/{policy_id}/privacy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
policy_id	Yes	String	Protection policy ID. You can call the ListPolicy API to obtain the policy ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page	No	Integer	Page number of the data to be returned in a query. The value range is 0 to 100000. The default value is 1, indicating that data on the first page is returned.
pagesize	No	Integer	Number of results on each page in query pagination. The value range is 1 to 100. The default value is 10, indicating that each page contains 10 results.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	auth token
Content-Type	Yes	String	Content type Default: application/json;charset=utf8

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Number of rules
items	Array of PrivacyResponseBody objects	Rule

**Table 5** PrivacyResponseBody
Parameter	Type	Description
id	String	Rule ID
policyid	String	Policy ID
timestamp	Long	Time a rule is created. The value must be a 13-digit timestamp in millisecond.
status	Integer	Rule status. The value can be 0 (disabled) or 1 (enabled).
url	String	URL protected by the data masking rule
category	String	Masked field Enumeration values: params cookie header form
index	String	Field name

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Messages

Example Requests

GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/privacy?enterprise_project_id=0

Example Responses

Status code: 200

{
  "total" : 1,
  "items" : [ {
    "category" : "params",
    "description" : "",
    "id" : "41a5674e03a1470a90ac4761ec4657b4",
    "index" : "password",
    "policyid" : "1f016cde588646aca3fb19f277c44d03",
    "status" : 1,
    "timestamp" : 1656504425319,
    "url" : "/login"
  } ]
}