文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据脱敏/ 查询脱敏模板详情 - ShowMaskTemplateDetail
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询脱敏模板详情 - ShowMaskTemplateDetail

功能介绍

功能介绍：查询脱敏模板详情

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

template_id

是

String

参数解释：

脱敏模板ID

约束限制：

不涉及

取值范围：

字符长度10-64，满足正则匹配"^[a-zA-Z0-9-]{10,64}$"

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

template_id

String

参数解释：

脱敏模板标识

取值范围：

不涉及

name

String

参数解释：

脱敏模板名称

取值范围：

不涉及

description

String

参数解释：

资源描述信息

取值范围：

不涉及

scan_template_id

String

参数解释：

关联扫描模板标识

取值范围：

不涉及

category

String

参数解释：

脱敏模板类别

取值范围：

  • BUILT_IN-内置

  • BUILT_IN_COPY-内置拷贝

  • BUILT_SELF-自建

rules

Array of TemplateRuleDetail objects

参数解释：

脱敏规则详情列表

取值范围：

不涉及

scan_rule_id

String

参数解释：

关联扫描规则标识

取值范围：

不涉及

scan_rule_name

String

参数解释：

扫描规则名称

取值范围：

不涉及

classification_id

String

参数解释：

分类分级标识

取值范围：

不涉及

mask_rule_id

String

参数解释：

脱敏规则标识

取值范围：

不涉及

mask_algorithm_type

String

参数解释：

脱敏算法类型

取值范围：

不涉及

mask_algorithm

String

参数解释：

脱敏算法

取值范围：

不涉及
表4 TemplateRuleDetail

参数

参数类型

描述

scan_rule_id

String

参数解释：

模板规则详情ID

取值范围：

不涉及

scan_rule_name

String

参数解释：

扫描规则名称

取值范围：

不涉及

classification_id

String

参数解释：

模板规则详情ID

取值范围：

不涉及

mask_rule_id

String

参数解释：

模板规则详情ID

取值范围：

不涉及

mask_algorithm_type

String

参数解释：

脱敏算法类型

取值范围：

不涉及

mask_algorithm

String

参数解释：

脱敏算法

取值范围：

不涉及

请求示例

无

响应示例

状态码：200

{
  "template_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "name" : "mask-template-01",
  "description" : "客户敏感字段脱敏模板",
  "scan_template_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "category" : "BUILT_IN",
  "rules" : [ {
    "scan_rule_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "scan_rule_name" : "phone-ident-rule",
    "classification_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e",
    "mask_rule_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "mask_algorithm_type" : "MASK_BY_HASH",
    "mask_algorithm" : "SHA256"
  } ],
  "scan_rule_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
  "scan_rule_name" : "phone-ident-rule",
  "classification_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e",
  "mask_rule_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "mask_algorithm_type" : "MASK_BY_HASH",
  "mask_algorithm" : "SHA256"
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

父主题： 数据脱敏

相关文档