编辑水印嵌入任务 - UpdateDbEmbedTasks
功能介绍
功能介绍:编辑指定水印嵌入任务,修改任务名称、调度方式、水印内容及数据库信息,编辑后按新配置执行。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/data-watermark-embed-tasks/{id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| id | 是 | Long | 参数解释: 水印嵌入任务ID,可通过查询水印嵌入任务列表接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| task_name | 是 | String | 参数解释: 数据库嵌入任务名称 约束限制: 满足正则匹配"^[\u4E00-\u9FA5\uF900-\uFA2D\w-]{1,255}$" 取值范围: 不涉及 默认取值: 不涉及 |
| schedule_type | 否 | String | 参数解释: 数据库嵌入任务类型 约束限制: 最大长度65535字符 取值范围: 默认取值: 不涉及 |
| start_time | 否 | Long | 参数解释: 任务开始时间,为毫秒级Unix时间戳,表示水印嵌入任务的计划开始时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| start_now | 是 | Boolean | 参数解释: 是否立即开始 约束限制: 不涉及 取值范围: 默认取值: false |
| schedule_switch | 否 | Boolean | 参数解释: 是否启用调度 约束限制: 不涉及 取值范围: 默认取值: true |
| db_water_param | 是 | DbWatermarkParam object | 参数解释: 数据库水印参数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| error_code | 是 | Integer | 参数解释: 水印纠错等级,标识水印纠错能力的等级 约束限制: 仅支持1~4四个取值 取值范围: 默认取值: 不涉及 |
| water_mark | 是 | String | 参数解释: 水印 约束限制: 满足正则匹配"^[\u4e00-\u9fa5a-zA-Z0-9]+$",最大长度256字符 取值范围: 不涉及 默认取值: 不涉及 |
| watermark_version | 是 | String | 参数解释: 水印版本 约束限制: 仅支持V1和V2两个版本 取值范围: 默认取值: 不涉及 |
| watermark_describe | 否 | String | 参数解释: 水印描述 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| source_db_info | 是 | DbInfo object | 参数解释: 源数据库信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| target_db_info | 是 | DbInfo object | 参数解释: 目标数据库信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| selected_fields | 否 | Array of MetaInfoColumnInfo objects | 参数解释: 选中的字段列表,数组元素为ColumnInfo对象,包含列名和列类型信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| params | 是 | Array of EmbedParam objects | 参数解释: 嵌入参数列表,数组元素为EmbedParam对象,包含新列名、新列类型、伪装策略及伪装参数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| watermark_key | 是 | String | 参数解释: 数据库水印参数密钥 约束限制: 最大长度128字符 取值范围: 不涉及 默认取值: 不涉及 |
| embed_mode | 是 | String | 参数解释: 数据库水印参数模式 约束限制: 仅支持EMBED_FAKE_ROW、EMBED_FAKE_COLUMN、EMBED_COLUMN三种模式 取值范围: 默认取值: 不涉及 |
| row_spacing | 否 | String | 参数解释: 行间距,水印嵌入时水印行之间的间隔距离,单位为像素,用于控制水印在数据中的布局密度。 约束限制: 不涉及 取值范围: 字符串类型,长度0~64字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| new_column_name | 是 | String | 参数解释: 新列名 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| new_column_type | 是 | String | 参数解释: 新列类型 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| fake_strategy | 是 | String | 参数解释: 伪装策略 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| fake_param | 否 | FakeParam object | 参数解释: 伪装参数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| random_begin | 否 | String | 参数解释: 随机数范围起始值 取值范围: 不涉及 约束限制: 不涉及 默认取值: 不涉及 |
| random_end | 否 | String | 参数解释: 随机数范围结束值 取值范围: 不涉及 约束限制: 不涉及 默认取值: 不涉及 |
| random_accuracy | 否 | Integer | 参数解释: 随机数精度 取值范围: 不涉及 约束限制: 不涉及 默认取值: 不涉及 |
| random_distribute | 否 | String | 参数解释: 随机数分布,以逗号分隔 取值范围: 不涉及 约束限制: 不涉及 默认取值: 不涉及 |
| string_distribute | 否 | String | 参数解释: 字符串分布,以逗号分隔 取值范围: 不涉及 约束限制: 不涉及 默认取值: 不涉及 |
| address_accuracy | 否 | String | 参数解释: 地址精度 取值范围: 不涉及 约束限制: 不涉及 默认取值: 不涉及 |
| date_begin | 否 | String | 参数解释: 日期范围开始 取值范围: 不涉及 约束限制: 不涉及 默认取值: 不涉及 |
| date_end | 否 | String | 参数解释: 日期范围结束 取值范围: 不涉及 约束限制: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| db_type | 否 | String | 参数解释: 数据库类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| ins_id | 否 | String | 参数解释: 实例ID,标识数据库实例,可通过查询数据库实例列表接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| ins_name | 否 | String | 参数解释: 实例名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| db_id | 否 | String | 参数解释: 数据库ID,标识目标数据库,可通过查询数据库列表接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| db_name | 否 | String | 参数解释: 数据库名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| schema_name | 否 | String | 参数解释: 数据库schema(模式)名称,标识目标数据表所属的数据库模式 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| table_name | 否 | String | 参数解释: 数据库表名称,标识要嵌入水印的目标数据表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
请求示例
编辑水印嵌入任务请求体
{
"task_name" : "embed-task-01",
"schedule_type" : "ONCE",
"start_time" : 1700000000000,
"start_now" : true,
"schedule_switch" : true,
"db_water_param" : {
"params" : [ {
"new_column_name" : "wm_column",
"new_column_type" : "varchar",
"fake_strategy" : "RANDOM"
} ],
"watermark_key" : "dsc-wm-key-01",
"embed_mode" : "EMBED_FAKE_ROW",
"row_spacing" : "100"
},
"error_code" : 1,
"water_mark" : "dsc-embed-watermark-01",
"watermark_version" : "V1",
"watermark_describe" : "客户数据水印嵌入",
"source_db_info" : {
"ins_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
"db_name" : "customer_db",
"db_type" : "MYSQL"
},
"target_db_info" : {
"ins_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"db_name" : "customer_mask_db",
"db_type" : "MYSQL"
},
"selected_fields" : [ {
"column_name" : "phone",
"column_type" : "varchar"
}, {
"column_name" : "email",
"column_type" : "varchar"
} ]
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "编辑水印嵌入任务成功",
"id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 编辑水印嵌入任务成功 |
错误码
请参见错误码。