文档首页/ 数据安全中心 DSC/ API参考/ API/ 脱敏模板/ 查询脱敏模板列表 - ListMaskTemplates
更新时间:2026-10-20 GMT+08:00
分享

查询脱敏模板列表 - ListMaskTemplates

功能介绍

功能介绍:分页查询脱敏模板列表,返回模板ID、名称、规则数量等信息,支持按偏移和数量控制分页。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/mask/mask-algorithm-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

分页查询时每页返回的条目数量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

20

offset

否

Integer

参数解释:

分页查询的偏移量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Long

参数解释:

总记录数

取值范围:

不涉及

templates

Array of MaskTemplateItem objects

参数解释:

脱敏模板列表

取值范围:

不涉及

MaskTemplateItem项

不涉及

取值范围:

不涉及

不涉及'

表5 MaskTemplateItem

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

脱敏模板名称

取值范围:

不涉及

description

String

参数解释:

资源描述信息

取值范围:

不涉及

scan_template_id

String

参数解释:

脱敏模板项ID

取值范围:

不涉及

scan_template_name

String

参数解释:

扫描模板名称

取值范围:

不涉及

rule_count

Integer

参数解释:

脱敏模板项数量

取值范围:

不涉及

task_count

Integer

参数解释:

关联任务数量,表示使用该脱敏模板的脱敏任务总数

取值范围:

不涉及

create_time

Long

参数解释:

创建时间,为毫秒级Unix时间戳,表示脱敏模板创建的时间点

取值范围:

毫秒级Unix时间戳

update_time

Long

参数解释:

更新时间,为毫秒级Unix时间戳,表示脱敏模板最近一次更新的时间点

取值范围:

毫秒级Unix时间戳

请求示例

无

响应示例

状态码:200

{
  "total" : 1,
  "templates" : [ {
    "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "name" : "mask-template-01",
    "description" : "客户敏感字段脱敏模板",
    "scan_template_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "scan_template_name" : "scan-template-01",
    "rule_count" : 5,
    "task_count" : 5,
    "create_time" : 1700000000000,
    "update_time" : 1700000600000
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档