Querying the Data Masking Rule List¶

Function¶

This API is used to query the data masking rule list.

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	Policy ID. It can be obtained by calling the ListPolicy API.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
page	No	Integer	Page
pagesize	No	Integer	Number of records on each page. The maximum value is 2147483647.

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token
Content-Type	No	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	Rules

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

Status code: 400

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 7** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 8** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests¶

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

Example Responses¶

Status code: 200

Request succeeded.

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

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.

last updated: 2024-11-14 08:44 UTC - commit: 0dac5e70f288fcbceae9b3712e8d35da924d7c2c