获取水印嵌入任务列表 - ListAllDbEmbedTasks
功能介绍
功能介绍:分页查询数据库水印嵌入任务列表,支持按任务名称、调度类型、任务状态等条件筛选,返回任务总数及任务详情列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/data-watermark-embed-tasks
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 任务名模糊查询,按任务名称进行模糊匹配筛选。 约束限制: 不涉及 取值范围: 字符串类型,长度0~255字符 默认取值: 不涉及 |
| status | 否 | String | 参数解释: 任务状态过滤,按水印嵌入任务当前状态精确筛选。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| start | 否 | Long | 参数解释: 任务查询起始时间,毫秒级Unix时间戳,筛选任务创建时间大于等于该值的记录。 约束限制: 不涉及 取值范围: 整数,0~9223372036854775807 默认取值: 不涉及 |
| end | 否 | Long | 参数解释: 任务查询终止时间,毫秒级Unix时间戳,筛选任务创建时间小于等于该值的记录。 约束限制: 不涉及 取值范围: 整数,0~9223372036854775807 默认取值: 不涉及 |
| id | 否 | Long | 参数解释: 任务ID,按水印嵌入任务ID精确查询。 约束限制: 不涉及 取值范围: 整数,0~9223372036854775807 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 分页偏移量,从第几条记录开始返回。 约束限制: 不涉及 取值范围: 整数,大于等于0 默认取值: 1 |
| limit | 否 | Integer | 参数解释: 每页返回的最大记录数。 约束限制: 不涉及 取值范围: 整数,大于等于0 默认取值: 10 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | Array of TaskDetail objects | 参数解释: 水印嵌入任务结果列表,数组中的每个元素为一条水印嵌入任务记录 取值范围: 不涉及 |
| total_num | Long | 参数解释: 数据库水印嵌入响应数量 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| task_name | String | 参数解释: 任务详情名称 取值范围: 不涉及 |
| schedule_type | String | 参数解释: 任务调度类型 取值范围: |
| start_time | Long | 参数解释: 任务开始时间,水印提取任务计划或实际开始执行的时间点,毫秒级Unix时间戳。 取值范围: 整数,0~9223372036854775807 |
| start_now | Boolean | 参数解释: 是否立即开始 取值范围: true-是,false-否 |
| schedule_switch | Boolean | 参数解释: 是否启用调度 取值范围: true-是,false-否 |
| task_state | String | 参数解释: 任务详情状态 取值范围: |
| error_msg | String | 参数解释: 错误信息 取值范围: 不涉及 |
| task_end_time | Long | 参数解释: 任务结束时间,水印提取任务执行结束的时间点,毫秒级Unix时间戳。 取值范围: 整数,0~9223372036854775807 |
| task_create_time | Long | 参数解释: 任务创建时间,水印提取任务创建的时间点,毫秒级Unix时间戳。 取值范围: 整数,0~9223372036854775807 |
| error_code | Integer | 参数解释: 任务执行错误码,标识水印提取任务的执行结果状态,0表示执行成功,非0表示任务执行过程中出现错误。 取值范围: 不涉及 |
| water_mark | String | 参数解释: 水印内容 取值范围: 不涉及 |
| watermark_version | String | 参数解释: 水印版本 取值范围: 不涉及 |
| watermark_describe | String | 参数解释: 水印描述 取值范围: 不涉及 |
| source_db_info | DbInfo object | 参数解释: 源数据库信息 取值范围: 不涉及 |
| target_db_info | DbInfo object | 参数解释: 目标数据库信息 取值范围: 不涉及 |
| selected_fields | Array of ColumnInfo objects | 参数解释: 选中的字段列表,数组元素为对象,包含字段名、数据类型等信息 取值范围: 不涉及 |
| db_water_param | DbWatermarkParam object | 参数解释: 数据库水印参数信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| db_type | String | 参数解释: 数据库类型 取值范围: |
| ins_id | String | 参数解释: 实例ID,标识数据库实例,可通过查询数据库实例列表接口获取 取值范围: 不涉及 |
| ins_name | String | 参数解释: 实例名称 取值范围: 不涉及 |
| db_id | String | 参数解释: 数据库ID,标识目标数据库,可通过查询数据库列表接口获取 取值范围: 不涉及 |
| db_name | String | 参数解释: 数据库名称 取值范围: 不涉及 |
| schema_name | String | 参数解释: 数据库schema(模式)名称,标识目标数据表所属的数据库模式 取值范围: 不涉及 |
| table_name | String | 参数解释: 数据库表名称,标识要嵌入水印的目标数据表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| column_name | String | 参数解释: 字段名称,数据库表中选中的列名。 取值范围: 字符串类型,长度1~128字符 |
| column_type | String | 参数解释: 字段类型,数据库表中选中列的数据类型(如 varchar、int 等)。 取值范围: 字符串类型,长度1~64字符 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| params | Array of EmbedParam objects | 参数解释: 嵌入参数列表,数组元素为EmbedParam对象,包含新列名、新列类型、伪装策略及伪装参数 取值范围: 不涉及 |
| watermark_key | String | 参数解释: 数据库水印参数密钥 取值范围: 不涉及 |
| embed_mode | String | 参数解释: 数据库水印参数模式 取值范围: |
| row_spacing | String | 参数解释: 行间距,水印嵌入时水印行之间的间隔距离,单位为像素,用于控制水印在数据中的布局密度。 取值范围: 字符串类型,长度0~64字符 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| new_column_name | String | 参数解释: 新列名 取值范围: 不涉及 |
| new_column_type | String | 参数解释: 新列类型 取值范围: 不涉及 |
| fake_strategy | String | 参数解释: 伪装策略 取值范围: 不涉及 |
| 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 | 参数解释: 日期范围结束 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
{
"result" : [ {
"id" : 1001,
"task_name" : "embed-task-01",
"schedule_type" : "ONCE",
"start_time" : 1700000000000,
"start_now" : true,
"schedule_switch" : true,
"task_state" : "FINISHED",
"error_msg" : "任务执行成功",
"task_end_time" : 1700000600000,
"task_create_time" : 1700000000000,
"error_code" : 1,
"water_mark" : "dsc-embed-watermark-01",
"watermark_version" : "V1",
"watermark_describe" : "客户数据水印嵌入"
} ],
"total_num" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。