创建水印嵌入任务 - CreateDbEmbedTask
功能介绍
功能介绍:创建数据库水印嵌入任务,配置任务名称、调度方式、水印内容、源数据库与目标数据库信息,任务创建后可立即执行或按调度周期执行,返回任务执行结果。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/data-watermark-embed-task
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| task_name | 否 | String | 参数解释: 数据库嵌入任务名称 约束限制: 满足正则匹配"^[a-zA-Z\u4e00-\u9fa5]+[0-9a-zA-Z\u4e00-\u9fa5_-]*$" 取值范围: 不涉及 默认取值: 不涉及 |
| schedule_type | 否 | String | 参数解释: 数据库嵌入任务类型 约束限制: 最大长度65535字符 取值范围: 默认取值: 不涉及 |
| start_time | 否 | Long | 参数解释: 任务开始时间,毫秒级Unix时间戳,表示任务计划开始执行的时间点 约束限制: 取值范围为0~9999999999999 取值范围: 不涉及 默认取值: 不涉及 |
| start_now | 否 | Boolean | 参数解释: 是否立即开始 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| schedule_switch | 否 | Boolean | 参数解释: 是否启用调度 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| db_water_param | 否 | String | 参数解释: 数据库水印参数 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| error_code | 否 | Integer | 参数解释: 错误码,标识任务执行或校验过程中返回的错误编码 约束限制: 取值上限为2147483647 取值范围: 不涉及 默认取值: 不涉及 |
| 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 | 参数解释: 数据库schema(模式)名称,标识目标数据表所属的数据库模式 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| table_name | 否 | String | 参数解释: 数据库表名称,标识要嵌入水印的目标数据表 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
请求示例
无
响应示例
状态码:200
{
"status" : "success",
"msg" : "创建水印嵌入任务成功",
"id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 创建水印嵌入任务成功 |
错误码
请参见错误码。