文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据库脱敏/ 编辑脱敏模板 - UpdateTemplatesDb
更新时间:2026-11-13 GMT+08:00
分享

编辑脱敏模板 - UpdateTemplatesDb

功能介绍

  • 功能介绍:编辑脱敏模板,指定数据源、目标端和脱敏策略。

  • 说明:

    • 请求体结构取决于type参数,不同数据源类型对应不同字段。

    • type为MySQL/Oracle/Hive/MRS_HIVE/TDSQL/DLI/DMDBMS时,使用MySQL类请求体结构。

    • type为PostgreSQL/GreenPlum/DWS/KingBase/OpenGauss时,使用PG类请求体(DataSource/DataDest含schema字段)。

    • type为SQLServer/HBase时,使用SQLServer类请求体。

    • type为OBS时,DataSource为对象存储源(src_obs_bucket_name/src_obs_path),DataDest为对象存储目标端,Strategy为规则级脱敏(rule_name/enable)。

调用方法

请参见如何调用API。

授权信息

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

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

URI

PUT /v1/{project_id}/sdg/server/mask/dbs/templates/{template_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

template_id

是

String

参数解释:

脱敏模板ID,可通过查询脱敏模板列表接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

参数解释:

数据源类型,决定请求体结构和脱敏方式。

约束限制:

不涉及

取值范围:

  • MySQL-MySQL数据库

  • PostgreSQL-PostgreSQL数据库

  • GreenPlum-GreenPlum数据库

  • KingBase-人大金仓数据库

  • OpenGauss-高斯数据库

  • DMDBMS-达梦数据库

  • DWS-DWS数据仓库

  • SQLServer-SQLServer数据库

  • MRS_HIVE-MRS_Hive

  • Hive-Hive

  • Oracle-Oracle数据库

  • HBase-HBase数据库

  • TDSQL-TDSQL数据库

  • DLI-DLI数据湖探索

  • OBS-OBS对象存储

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

template_id

是

String

参数解释:

脱敏模板ID,标识被编辑的脱敏模板

约束限制:

必填

取值范围:

不涉及

默认取值:

不涉及

template_name

是

String

参数解释:

脱敏模板名称

约束限制:

必填

取值范围:

不涉及

默认取值:

不涉及

type

是

String

参数解释:

数据源类型,与query参数type一致

约束限制:

必填

取值范围:

  • MySQL-MySQL数据库

  • PostgreSQL-PostgreSQL数据库

  • GreenPlum-GreenPlum数据库

  • KingBase-人大金仓数据库

  • OpenGauss-高斯数据库

  • DMDBMS-达梦数据库

  • DWS-DWS数据仓库

  • SQLServer-SQLServer数据库

  • MRS_HIVE-MRS_Hive

  • Hive-Hive

  • Oracle-Oracle数据库

  • HBase-HBase数据库

  • TDSQL-TDSQL数据库

  • DLI-DLI数据湖探索

  • OBS-OBS对象存储

默认取值:

不涉及

data_source

是

Array of MaskDataSource objects

参数解释:

数据源列表,数组元素为对象,包含源实例ID、数据源ID、库名、表名、选择列、集群ID、分区筛选条件等信息

约束限制:

必填,最少1个

取值范围:

不涉及

默认取值:

不涉及

data_dest

是

Array of MaskDataDest objects

参数解释:

数据目标列表,数组元素为对象,包含目标实例ID、目标数据源ID、库名、表名、集群ID、桶名、文件路径等信息

约束限制:

必填,最少1个

取值范围:

不涉及

默认取值:

不涉及

strategy

否

Array of MaskStrategy objects

参数解释:

脱敏策略列表,指定列级或规则级脱敏算法,数组元素为对象,包含源列名、目标列名、脱敏算法、算法类型、算法参数、算法ID等信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

trigger_time

否

String

参数解释:

触发时间,指定脱敏任务的调度触发时间

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

mask_ratio

否

Double

参数解释:

脱敏比例

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

increment_key

否

String

参数解释:

增量字段

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

ak

否

String

参数解释:

AK访问密钥,仅用于DLI脱敏

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sk

否

String

参数解释:

SK秘密密钥,仅用于DLI脱敏

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

mask_template_id

否

String

参数解释:

脱敏模板ID,标识复制的源脱敏模板

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 MaskDataSource

参数

是否必选

参数类型

描述

source_ins_id

否

String

参数解释:

源实例ID。

约束限制:

数据库类型适用,OBS不适用。

取值范围:

不涉及

默认取值:

不涉及

data_source_id

否

String

参数解释:

数据源ID。

约束限制:

数据库类型适用。

取值范围:

不涉及

默认取值:

不涉及

db_name

否

String

参数解释:

数据库名称。

约束限制:

数据库类型适用,OBS不适用。

取值范围:

不涉及

默认取值:

不涉及

schema

否

String

参数解释:

数据模式名称。

约束限制:

PostgreSQL/GreenPlum/DWS/KingBase/OpenGauss/SQLServer/HBase适用。

取值范围:

不涉及

默认取值:

不涉及

table_name

否

String

参数解释:

表名称。

约束限制:

数据库类型适用。

取值范围:

不涉及

默认取值:

不涉及

choosing_columns

否

Array of strings

参数解释:

待脱敏的列名列表,数组元素为String类型,即列名。

约束限制:

数据库类型适用。

取值范围:

不涉及

默认取值:

不涉及

cluster_id

否

String

参数解释:

集群ID。

约束限制:

MySQL/PG/Hive类型适用,SQLServer不适用。

取值范围:

不涉及

默认取值:

不涉及

partition_filter

否

String

参数解释:

分区查询筛选条件。

约束限制:

仅MRS_HIVE和Hive适用。

取值范围:

不涉及

默认取值:

不涉及

partition_filter_type

否

String

参数解释:

分区查询筛选条件类型(选择或自定义)。

约束限制:

仅MRS_HIVE和Hive适用。

取值范围:

不涉及

默认取值:

不涉及

src_asset_id

否

String

参数解释:

源资产ID。

约束限制:

仅OBS适用。

取值范围:

不涉及

默认取值:

不涉及

src_obs_bucket_name

否

String

参数解释:

源OBS桶名。

约束限制:

仅OBS适用。

取值范围:

不涉及

默认取值:

不涉及

src_obs_path

否

String

参数解释:

源OBS路径。

约束限制:

仅OBS适用。

取值范围:

不涉及

默认取值:

不涉及

recursive

否

Boolean

参数解释:

是否递归扫描。

约束限制:

仅OBS适用。

取值范围:

true

false

默认取值:

不涉及

file_name_prefix

否

String

参数解释:

文件名前缀过滤。

约束限制:

仅OBS适用。

取值范围:

不涉及

默认取值:

不涉及

file_name_suffix

否

String

参数解释:

文件名后缀过滤。

约束限制:

仅OBS适用。

取值范围:

不涉及

默认取值:

不涉及

mask_type

否

String

参数解释:

OBS具体脱敏任务类型,文本脱敏或图片脱敏。

约束限制:

仅OBS适用。

取值范围:

不涉及

默认取值:

不涉及

表6 MaskDataDest

参数

是否必选

参数类型

描述

dest_ins_id

否

String

参数解释:

目标实例ID。

约束限制:

数据库类型适用,OBS不适用。

取值范围:

不涉及

默认取值:

不涉及

data_dest_id

否

String

参数解释:

目标数据端ID。

约束限制:

数据库类型适用。

取值范围:

不涉及

默认取值:

不涉及

db_name

否

String

参数解释:

目标库名称。

约束限制:

数据库类型适用,OBS不适用。

取值范围:

不涉及

默认取值:

不涉及

schema

否

String

参数解释:

目标模式名称。

约束限制:

PostgreSQL/GreenPlum/DWS/KingBase/OpenGauss/SQLServer/HBase适用。

取值范围:

不涉及

默认取值:

不涉及

table_name

否

String

参数解释:

目标表名称。

约束限制:

数据库类型适用。

取值范围:

不涉及

默认取值:

不涉及

cluster_id

否

String

参数解释:

目标集群ID。

约束限制:

MySQL/PG/Hive类型适用。

取值范围:

不涉及

默认取值:

不涉及

type

否

String

参数解释:

目标端类型。

约束限制:

仅MySQL类适用。

取值范围:

不涉及

默认取值:

不涉及

bucket

否

String

参数解释:

目标OBS桶名。

约束限制:

仅MySQL类适用。

取值范围:

不涉及

默认取值:

不涉及

file_path

否

String

参数解释:

目标文件路径。

约束限制:

仅MySQL类适用。

取值范围:

不涉及

默认取值:

不涉及

file_name

否

String

参数解释:

目标文件名。

约束限制:

仅MySQL类适用。

取值范围:

不涉及

默认取值:

不涉及

dst_asset_id

否

String

参数解释:

目标资产ID。

约束限制:

仅OBS适用。

取值范围:

不涉及

默认取值:

不涉及

dst_obs_bucket_name

否

String

参数解释:

目标OBS桶名。

约束限制:

仅OBS适用。

取值范围:

不涉及

默认取值:

不涉及

dst_obs_path

否

String

参数解释:

目标OBS路径。

约束限制:

仅OBS适用。

取值范围:

不涉及

默认取值:

不涉及

表7 MaskStrategy

参数

是否必选

参数类型

描述

src_column_name

否

String

参数解释:

源列名。

约束限制:

数据库类型适用,OBS不适用。

取值范围:

不涉及

默认取值:

不涉及

dest_column_name

否

String

参数解释:

目标列名。

约束限制:

数据库类型适用,OBS不适用。

取值范围:

不涉及

默认取值:

不涉及

algorithm

否

String

参数解释:

脱敏算法名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

algorithm_type

否

String

参数解释:

脱敏算法类型。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

parameter

否

String

参数解释:

脱敏算法参数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

algorithm_id

否

String

参数解释:

脱敏算法ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

rule_name

否

String

参数解释:

规则名称。

约束限制:

仅OBS适用。

取值范围:

不涉及

默认取值:

不涉及

enable

否

Boolean

参数解释:

是否启用该规则。

约束限制:

仅OBS适用。

取值范围:

true

false

默认取值:

不涉及

响应参数

状态码:200

表8 响应Body参数

参数

参数类型

描述

status

String

参数解释:

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

取值范围:

  • success:成功

  • failed:失败

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

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

取值范围:

不涉及

请求示例

编辑脱敏模板

{
  "template_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "template_name" : "db-mask-template-01",
  "type" : "MySQL",
  "data_source" : [ {
    "source_ins_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "data_source_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "db_name" : "customer_db",
    "table_name" : "customer_info",
    "choosing_columns" : [ "phone", "id_card", "email" ],
    "cluster_id" : "c3d4e5f6-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
    "partition_filter" : "dt='20260101'",
    "partition_filter_type" : "AUTO"
  } ],
  "data_dest" : [ {
    "dest_ins_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "data_dest_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e",
    "db_name" : "customer_db",
    "table_name" : "customer_info",
    "cluster_id" : "c3d4e5f6-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
    "type" : "DB",
    "bucket" : "dsc-asset-bucket-01",
    "file_path" : "dst/customer/financial-report.pdf",
    "file_name" : "financial-report.pdf"
  } ],
  "strategy" : [ {
    "src_column_name" : "phone",
    "dest_column_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_ratio" : 80,
  "increment_key" : "id",
  "mask_template_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
}

响应示例

状态码:200

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

状态码

状态码

描述

200

编辑脱敏模板成功

错误码

请参见错误码。

相关文档