文档首页/ 数据安全中心 DSC/ API参考/ API/ 大数据脱敏/ 添加ES脱敏模板 - CreateTemplatesBigdata
更新时间:2026-11-13 GMT+08:00
分享

添加ES脱敏模板 - CreateTemplatesBigdata

功能介绍

添加ES脱敏模板

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/sdg/server/mask/bigdata/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

参数解释:

脱敏类型,用于指定添加的ES脱敏模板类型及其适用场景

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

template_name

是

String

参数解释:

脱敏模板名称

约束限制:

必填

取值范围:

不涉及

默认取值:

不涉及

type

是

String

参数解释:

模板类型,仅支持ES

约束限制:

必填

取值范围:

  • ES-Elasticsearch

默认取值:

不涉及

data_source

是

Array of DataSource objects

参数解释:

数据源信息列表,数组元素为DataSource对象,包含源端实例ID、数据源ID、索引名称、类型名称及选择字段

约束限制:

必填

取值范围:

不涉及

默认取值:

不涉及

data_dest

是

Array of DataDest objects

参数解释:

数据目的端信息列表,数组元素为DataDest对象,包含目的端实例ID、目的端数据ID、索引名称及类型名称

约束限制:

必填

取值范围:

不涉及

默认取值:

不涉及

strategy

否

Array of Strategy objects

参数解释:

脱敏策略列表,数组元素为Strategy对象,包含源字段名、目的字段名、算法、算法类型、参数及算法ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

trigger_time

否

String

参数解释:

触发时间,cron表达式

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

mask_template_id

否

String

参数解释:

脱敏模板ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 DataSource

参数

是否必选

参数类型

描述

source_ins_id

否

String

参数解释:

源端实例ID

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

data_source_id

否

String

参数解释:

数据源端ID

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

index_name

否

String

参数解释:

源端索引名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

type_name

否

String

参数解释:

源端类型名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

choosing_fields

否

Array of strings

参数解释:

脱敏任务选择的字段列表,数组元素为String类型,每个元素为一个ES字段名

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表6 DataDest

参数

是否必选

参数类型

描述

dest_ins_id

否

String

参数解释:

目的端实例ID

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

data_dest_id

否

String

参数解释:

数据目的端ID

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

index_name

否

String

参数解释:

目的端索引名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

type_name

否

String

参数解释:

目的端类型名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

表7 Strategy

参数

是否必选

参数类型

描述

src_field_name

否

String

参数解释:

源字段名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

dest_field_name

否

String

参数解释:

目标字段名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

algorithm

否

String

参数解释:

脱敏算法

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

algorithm_type

否

String

参数解释:

脱敏算法类型

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

parameter

否

String

参数解释:

算法参数

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

algorithm_id

否

String

参数解释:

脱敏算法ID

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表8 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求处理状态,标识任务的执行结果

取值范围:

  • success:成功

  • failed:失败

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

被删除的水印嵌入任务对应的资源ID

取值范围:

不涉及

请求示例

添加ES脱敏模板

{
  "template_name" : "es-mask-template-01",
  "type" : "ES",
  "data_source" : [ {
    "source_ins_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "data_source_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "index_name" : "customer_info_index",
    "type_name" : "_doc",
    "choosing_fields" : [ "phone", "id_card" ]
  } ],
  "data_dest" : [ {
    "dest_ins_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "data_dest_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e",
    "index_name" : "customer_info_index",
    "type_name" : "_doc"
  } ],
  "strategy" : [ {
    "src_field_name" : "phone",
    "dest_field_name" : "phone_masked",
    "algorithm" : "SHA256",
    "algorithm_type" : "MASK_BY_HASH",
    "parameter" : "8",
    "algorithm_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
  } ],
  "trigger_time" : "0 0 2 * * ?",
  "mask_template_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
}

响应示例

状态码:200

{
  "status" : "success",
  "msg" : "添加ES脱敏模板成功",
  "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
}

状态码

状态码

描述

200

添加ES脱敏模板成功

错误码

请参见错误码。

相关文档