编辑水印嵌入任务 - 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-32,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| id | 是 | Long | 参数解释: 任务ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| table_name_regex | 否 | String | 参数解释: 表名称正则匹配 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| task_name_regex | 否 | String | 参数解释: 任务名称正则表达式 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| watermark_regex | 否 | String | 参数解释: 水印正则表达式 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| task_name | 否 | String | 参数解释: 数据库嵌入任务名称 约束限制: 满足正则匹配"^[a-zA-Z\u4e00-\u9fa5]+[0-9a-zA-Z\u4e00-\u9fa5_-]*$" 取值范围: 不涉及 默认取值: 不涉及 |
| schedule_type | 否 | String | 参数解释: 数据库嵌入任务类型 约束限制: 最大长度65535字符 取值范围: 默认取值: 不涉及 |
| task_start_time | 否 | Long | 参数解释: 任务开始时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| start_now | 否 | Boolean | 参数解释: 是否立即开始 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| schedule_switch | 否 | Boolean | 参数解释: 是否启用调度 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| db_watermark_param | 否 | String | 参数解释: 数据库水印参数 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| error_code | 否 | Integer | 参数解释: 数据库嵌入任务码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| water_mark | 否 | String | 参数解释: 水印 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| watermark_version | 否 | String | 参数解释: 水印版本 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| watermark_describe | 否 | String | 参数解释: 水印描述 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| source_db_info | 否 | String | 参数解释: 源数据库信息 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| target_db_info | 否 | String | 参数解释: 目标数据库信息 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| db_type | 否 | String | 参数解释: 数据库类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| ins_id | 否 | String | 参数解释: 数据库嵌入任务ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| ins_name | 否 | String | 参数解释: 数据库嵌入任务名称 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| db_id | 否 | String | 参数解释: 数据库嵌入任务ID 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| db_name | 否 | String | 参数解释: 数据库名称 约束限制: 满足正则匹配"^[A-Za-z0-9_-]{0,30}$" 取值范围: 不涉及 默认取值: 不涉及 |
| schema_name | 否 | String | 参数解释: 数据库嵌入任务名称 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| table_name | 否 | String | 参数解释: 数据库嵌入任务名称 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 请求状态,success为成功。 取值范围: 不涉及 |
| msg | String | 参数解释: 提示信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID 取值范围: 不涉及 |
请求示例
编辑水印嵌入任务请求体
{
"table_name_regex" : ".*customer.*",
"task_name_regex" : ".*embed.*",
"watermark_regex" : ".*",
"task_name" : "embed-task-01",
"schedule_type" : "ONCE",
"task_start_time" : 1700000000000,
"start_now" : true,
"schedule_switch" : true,
"db_watermark_param" : "{\"watermark_key\":\"dsc-wm-key-01\",\"embed_mode\":\"EMBED_FAKE_ROW\",\"row_spacing\":\"100\"}",
"error_code" : 0,
"water_mark" : "dsc-embed-watermark-01",
"watermark_version" : "VERSION_1",
"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\"}",
"db_type" : "MYSQL",
"ins_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
"ins_name" : "dbss-instance-01",
"db_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"db_name" : "customer_db",
"schema_name" : "customer_schema",
"table_name" : "customer_info"
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "编辑水印嵌入任务成功",
"id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 编辑水印嵌入任务成功 |
错误码
请参见错误码。