获取数据库水印提取任务列表 - ListDbExtractTask
功能介绍
获取指定项目下的数据库水印提取任务列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/data-watermark-extract-tasks
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| end | 否 | Long | 结束时间(过滤条件) |
| id | 否 | Long | 任务ID(过滤条件) |
| limit | 否 | Integer | 每页显示的数量 |
| name | 否 | String | 任务名称(过滤条件) |
| offset | 否 | Integer | 分页偏移量 |
| start | 否 | Long | 开始时间(过滤条件) |
| status | 否 | String | 任务状态(过滤条件) |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | Array of TaskDetail objects | 任务详情列表 |
| total_num | Long | 总任务数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| db_water_param | DbWatermarkParam object | 数据库水印参数 |
| extract_running_flag | String | 提取运行状态 |
| file_name | String | 文件名称 |
| id | Long | 任务ID |
| 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_create_time | Long | 任务创建时间 |
| task_end_time | Long | 任务结束时间 |
| task_name | String | 任务名称 |
| task_state | String | 任务状态 |
| water_describe | String | 水印描述 |
| water_extract_result | String | 水印提取结果 |
| water_mark | String | 水印内容 |
| watermark_describe | String | 水印描述 |
| watermark_version | String | 水印版本 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| embed_mode | String | 嵌入模式 |
| params | Array of EmbedParam objects | 嵌入参数列表 |
| row_spacing | String | 行间距 |
| watermark_key | String | 水印密钥 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| fake_param | FakeParam object | 模拟参数配置 |
| fake_strategy | String | 模拟数据生成策略 |
| new_column_name | String | 新字段名称 |
| new_column_type | String | 新字段类型 |
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 获取成功 |
| 401 | 未授权 |
| 403 | 禁止访问 |
| 404 | 项目未找到 |
错误码
请参见错误码。