创建水印嵌入任务 - CreateDbEmbedTask

功能介绍

创建一个新的水印嵌入任务。

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/data-watermark-embed-tasks

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
db_water_param	否	DbWatermarkParam object	数据库水印参数
schedule_switch	否	Boolean	调度开关
schedule_type	否	String	调度类型
selected_fields	否	Array of ColumnInfo objects	选中的字段列表
source_db_info	否	DbInfo object	源数据库信息
start_now	否	Boolean	是否立即开始
start_time	否	Long	开始时间
target_db_info	否	DbInfo object	目标数据库信息
task_name	否	String	任务名称
water_mark	否	String	水印内容
watermark_describe	否	String	水印描述
watermark_version	否	String	水印版本

表3 DbWatermarkParam
参数	是否必选	参数类型	描述
embed_mode	否	String	嵌入模式
params	否	Array of EmbedParam objects	嵌入参数列表
row_spacing	否	String	行间距
watermark_key	否	String	水印密钥

表4 EmbedParam
参数	是否必选	参数类型	描述
fake_param	否	FakeParam object	模拟参数配置
fake_strategy	否	String	模拟数据生成策略
new_column_name	否	String	新字段名称
new_column_type	否	String	新字段类型

表5 FakeParam
参数	是否必选	参数类型	描述
address_accuracy	否	String	地址精度
date_begin	否	String	日期范围开始
date_end	否	String	日期范围结束
random_accuracy	否	Integer	随机精度
random_begin	否	String	随机范围开始
random_distribute	否	String	随机分布方式
random_end	否	String	随机范围结束
string_distribute	否	String	字符串分布方式

表6 ColumnInfo
参数	是否必选	参数类型	描述
column_name	否	String	字段名称
column_type	否	String	字段类型

表7 DbInfo
参数	是否必选	参数类型	描述
db_id	否	String	数据库ID
db_name	否	String	数据库名称
db_type	否	String	数据库类型
ins_id	否	String	实例ID
ins_name	否	String	实例名称
schema_name	否	String	数据库模式名称
table_name	否	String	表名称

响应参数

状态码：200

表8 响应Body参数
参数	参数类型	描述
id	String	任务ID
msg	String	消息描述
status	String	状态

状态码：201

任务已创建

请求示例

POST /v1/{project_id}/data-watermark-embed-tasks

{
  "db_water_param" : {
    "params" : [ {
      "new_column_name" : "test",
      "new_column_type" : "varchar",
      "fake_strategy" : "cid",
      "fake_param" : { }
    } ],
    "embed_mode" : "EMBED_FAKE_COLUMN",
    "watermark_key" : "0c3039178b80d36e2fd0c009a6bd4f05"
  },
  "schedule_switch" : true,
  "schedule_type" : "ONCE",
  "source_db_info" : {
    "db_type" : "MySQL",
    "ins_id" : "99a4a5c2904e4028bf4619f3a1e4a2dbin01",
    "ins_name" : "rds-test",
    "db_name" : "test_db",
    "db_id" : "6fd23d4b28c247588641f3304bfa8f8a",
    "table_name" : "person_info"
  },
  "start_now" : true,
  "start_time" : 0,
  "target_db_info" : {
    "db_type" : "MySQL",
    "ins_id" : "99a4a5c2904e4028bf4619f3a1e4a2dbin01",
    "ins_name" : "test_db",
    "db_id" : "6fd23d4b28c247588641f3304bfa8f8a",
    "db_name" : "test_db",
    "table_name" : "fake_info"
  },
  "task_name" : "test",
  "water_mark" : "HWTest",
  "watermark_version" : "V2"
}