文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据脱敏/ 展示数据库脱敏任务 - CreateSearch
更新时间:2026-10-09 GMT+08:00
分享

展示数据库脱敏任务 - CreateSearch

功能介绍

展示数据库脱敏任务

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/sdg/server/mask/dbs/templates/search

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

限制

约束限制:

最大值2147483647

取值范围:

不涉及

默认取值:

不涉及

template_name

否

String

参数解释:

模板名称

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

type

否

String

参数解释:

类型

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

sequence

否

String

参数解释:

序列

约束限制:

最大长度1024字符

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

数据库模板总数

取值范围:

不涉及

responses

Array of SingleDBTemplateResponse objects

参数解释:

响应列表列表

取值范围:

不涉及

template_list

Array of strings

template列表

表5 SingleDBTemplateResponse

参数

参数类型

描述

task_source

String

参数解释:

任务来源

取值范围:

不涉及

id

String

参数解释:

模板ID

取值范围:

不涉及

type

String

参数解释:

模板类型

取值范围:

不涉及

db_type

String

参数解释:

数据库类型

取值范围:

不涉及

status

Integer

参数解释:

任务状态

取值范围:

不涉及

run_status

String

参数解释:

任务运行状态

取值范围:

不涉及

progress

Integer

参数解释:

任务执行进度

取值范围:

不涉及

template_name

String

参数解释:

模板名称

取值范围:

不涉及

data_source

Array of DataSource objects

参数解释:

数据源配置列表

取值范围:

不涉及

data_dest

Array of DataDest objects

参数解释:

数据目的端配置列表

取值范围:

不涉及

strategy

Array of Strategy objects

参数解释:

脱敏策略列表

取值范围:

不涉及

trigger_time

String

参数解释:

任务触发时间

取值范围:

不涉及

workspace_id

String

参数解释:

工作空间ID

取值范围:

不涉及

create_time

Long

参数解释:

创建时间

取值范围:

不涉及

mask_ratio

Integer

参数解释:

脱敏比例

取值范围:

不涉及

increment_key

String

参数解释:

增量同步键

取值范围:

不涉及

scan_template_id

String

参数解释:

扫描模板ID

取值范围:

不涉及

mask_template_id

String

参数解释:

脱敏模板ID

取值范围:

不涉及

partition_filter

String

参数解释:

分区过滤条件

取值范围:

不涉及

partition_filter_type

String

参数解释:

分区过滤类型

取值范围:

不涉及

algorithm

String

参数解释:

算法

取值范围:

不涉及

algorithm_id

String

参数解释:

算法ID

取值范围:

不涉及

algorithm_type

String

参数解释:

算法类型

取值范围:

不涉及

bucket

String

参数解释:

桶

取值范围:

不涉及

choosing_columns

Array of strings

选择列

data_dest_id

String

参数解释:

数据目的ID

取值范围:

不涉及

data_source_id

String

参数解释:

数据源ID

取值范围:

不涉及

db_name

String

参数解释:

数据库名称

取值范围:

不涉及

dest_column_name

String

参数解释:

目标列名

取值范围:

不涉及

dest_ins_id

String

参数解释:

目的实例ID

取值范围:

不涉及

dst_asset_id

String

参数解释:

目标资产ID

取值范围:

不涉及

dst_obs_bucket_name

String

参数解释:

目标OBS桶名称

取值范围:

不涉及

dst_obs_path

String

参数解释:

目标OBS路径

取值范围:

不涉及

enable

Boolean

参数解释:

是否启用

取值范围:

true-是,false-否

file_name

String

参数解释:

文件名

取值范围:

不涉及

file_name_prefix

String

参数解释:

文件名前缀

取值范围:

不涉及

file_name_suffix

String

参数解释:

文件名后缀

取值范围:

不涉及

file_path

String

参数解释:

文件路径

取值范围:

不涉及

mask_type

String

参数解释:

mask类型

取值范围:

不涉及

parameter

Object

参数解释:

参数

取值范围:

不涉及

recursive

Boolean

参数解释:

是否递归

取值范围:

true-是,false-否

rule_name

String

参数解释:

规则名称

取值范围:

不涉及

schema

String

参数解释:

Schema名称

取值范围:

不涉及

source_ins_id

String

参数解释:

来源实例ID

取值范围:

不涉及

src_asset_id

String

参数解释:

源资产ID

取值范围:

不涉及

src_column_name

String

参数解释:

源列名

取值范围:

不涉及

src_obs_bucket_name

String

参数解释:

源OBS桶名称

取值范围:

不涉及

src_obs_path

String

参数解释:

源OBS路径

取值范围:

不涉及

table_name

String

参数解释:

表名

取值范围:

不涉及

template_id

String

参数解释:

模板ID

取值范围:

不涉及

表6 DataSource

参数

参数类型

描述

source_ins_id

String

参数解释:

源端实例ID

取值范围:

不涉及

data_source_id

String

参数解释:

数据源端ID

取值范围:

不涉及

index

String

参数解释:

源端序号

取值范围:

不涉及

type

String

参数解释:

源端类型

取值范围:

不涉及

choosing_fields

Array of strings

参数解释:

脱敏任务选择的字段列表

取值范围:

不涉及

表7 DataDest

参数

参数类型

描述

dest_ins_id

String

参数解释:

目的端实例ID

取值范围:

不涉及

data_dest_id

String

参数解释:

数据目的端ID

取值范围:

不涉及

index

String

参数解释:

目的端序号

取值范围:

不涉及

type

String

参数解释:

目的端类型

取值范围:

不涉及

表8 Strategy

参数

参数类型

描述

src_field_name

String

参数解释:

源字段名称

取值范围:

不涉及

dest_field_name

String

参数解释:

目标字段名称

取值范围:

不涉及

algorithm

String

参数解释:

脱敏算法

取值范围:

不涉及

algorithm_type

String

参数解释:

脱敏算法类型

取值范围:

不涉及

parameter

String

参数解释:

算法参数

取值范围:

不涉及

algorithm_id

String

参数解释:

脱敏算法ID

取值范围:

不涉及

请求示例

展示数据库脱敏任务

{
  "limit" : 10,
  "template_name" : "template-finance-01",
  "type" : "default-value",
  "sequence" : "1"
}

响应示例

状态码:200

{
  "total" : 0,
  "responses" : [ {
    "task_source" : "MANUAL",
    "id" : "00000000-0000-0000-0000-000000000000",
    "type" : "MANUAL",
    "db_type" : "mysql",
    "status" : 1,
    "run_status" : "RUNNING",
    "progress" : 0,
    "template_name" : "脱敏模板1",
    "data_source" : [ {
      "source_ins_id" : "00000000-0000-0000-0000-000000000000",
      "data_source_id" : "00000000-0000-0000-0000-000000000000",
      "index" : "0",
      "type" : "MANUAL",
      "choosing_fields" : [ "字段1" ]
    } ],
    "data_dest" : [ {
      "dest_ins_id" : "00000000-0000-0000-0000-000000000000",
      "data_dest_id" : "00000000-0000-0000-0000-000000000000",
      "index" : "0",
      "type" : "MANUAL"
    } ],
    "strategy" : [ {
      "src_field_name" : "src_field",
      "dest_field_name" : "dest_field",
      "algorithm" : "mask",
      "algorithm_type" : "STATIC",
      "parameter" : "{}",
      "algorithm_id" : "00000000-0000-0000-0000-000000000000"
    } ],
    "trigger_time" : "2024-01-01 00:00:00",
    "workspace_id" : "00000000-0000-0000-0000-000000000000",
    "create_time" : 0,
    "mask_ratio" : 0,
    "increment_key" : "id",
    "scan_template_id" : "00000000-0000-0000-0000-000000000000",
    "mask_template_id" : "00000000-0000-0000-0000-000000000000",
    "partition_filter" : "",
    "partition_filter_type" : "NONE"
  } ]
}

状态码

状态码

描述

200

操作成功

错误码

请参见错误码。

相关文档