文档首页/ 数据库安全服务 DBSS/ API参考/ API说明/ 审计规则-隐私数据保护/ 查询隐私数据脱敏规则 - ListAuditSensitiveMasksNew
更新时间：2026-07-10 GMT+08:00
查看PDF
分享

查询隐私数据脱敏规则 - ListAuditSensitiveMasksNew

功能介绍

查询隐私数据脱敏规则

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/audit/{instance_id}/sensitive/mask/rule

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-64。

默认取值：

不涉及

instance_id

是

String

参数解释：

实例ID。可通过查询实例列表接口ID字段获取

约束限制：

不涉及

取值范围：

以查询实例列表接口值为准，字符长度32-64。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

参数解释：

分页偏移量，从第一条数据偏移offset条数据后开始查询

约束限制：

仅支持大于等于0的整数

取值范围：

大于等于0

默认取值：

默认值为0

limit

否

String

参数解释：

每页查询记录数。

约束限制：

仅支持大于0的整数

取值范围：

大于0小于等于1000

默认取值：

默认值为100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

rules

Array of rules objects

规则列表

total

Integer

总数
表5 rules

参数

参数类型

描述

id

String

规则ID

name

String

规则名称

type

String

规则类型

  • BUILD_IN：系统内置

  • USER_DEFINE：自定义

regex

String

规则正则表达式

mask_value

String

替换值

status

String

规则状态

  • ON：启用

  • OFF：禁用

operate_time

String

操作时间

状态码：400

表6 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表7 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：403

表8 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表9 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：500

表10 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表11 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

/v1/{project_id}/audit/{instance_id}/sensitive/mask/rule

响应示例

状态码：200

成功

{
  "rules" : [ {
    "id" : "n34W2ngBo47GiyUSKOVl",
    "name" : "Passport NO.",
    "type" : "BUILD_IN",
    "regex" : "-",
    "mask_value" : "###",
    "status" : "ON",
    "operate_time" : "2030-01-01 00:00:06"
  }, {
    "id" : "nn4W2ngBo47GiyUSKOVP",
    "name" : "Military officer card NO.",
    "type" : "BUILD_IN",
    "regex" : "-",
    "mask_value" : "###",
    "status" : "ON",
    "operate_time" : "2030-01-01 00:00:05"
  }, {
    "id" : "nX4W2ngBo47GiyUSKOU9",
    "name" : "Ethnicity",
    "type" : "BUILD_IN",
    "regex" : "-",
    "mask_value" : "###",
    "status" : "ON",
    "operate_time" : "2030-01-01 00:00:04"
  }, {
    "id" : "mn4W2ngBo47GiyUSKOUO",
    "name" : "GPS Information",
    "type" : "BUILD_IN",
    "regex" : "-",
    "mask_value" : "###",
    "status" : "ON",
    "operate_time" : "2030-01-01 00:00:01"
  } ],
  "total" : 6
}

状态码

状态码

描述

200

成功

400

请求参数错误

403

认证失败

500

服务器内部错误

错误码

请参见错误码。