获取数据水印提取任务列表 - ListDbExtractTasks
功能介绍
功能介绍:分页查询数据水印提取任务列表,返回任务状态、水印提取结果等信息。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/data-watermark-extract-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 ExtractTaskDetail objects | 参数解释: 提取任务结果列表,数组中的每个元素为一条水印提取任务记录 取值范围: 不涉及 |
| total_num | Long | 参数解释: 提取结果总数 取值范围: 最小值0,最大值2147483647 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 提取任务ID 取值范围: 不涉及 |
| task_name | String | 参数解释: 提取任务名称 取值范围: 不涉及 |
| file_name | String | 参数解释: 文件名 取值范围: 不涉及 |
| water_describe | String | 参数解释: 水印描述 取值范围: 不涉及 |
| water_extract_result | String | 参数解释: 水印提取结果 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误信息 取值范围: 不涉及 |
| task_create_time | Long | 参数解释: 任务创建时间,Unix时间戳,单位为毫秒 取值范围: 不涉及 |
| task_end_time | Long | 参数解释: 任务结束时间,Unix时间戳,单位为毫秒 取值范围: 不涉及 |
| extract_running_flag | String | 参数解释: 提取运行状态 取值范围: |
请求示例
无
响应示例
状态码:200
{
"result" : [ {
"id" : 1001,
"task_name" : "extract-task-01",
"file_name" : "financial-report.csv",
"water_describe" : "客户数据水印提取",
"water_extract_result" : "asset-owner-001",
"error_msg" : "任务执行成功",
"task_create_time" : 1700000000000,
"task_end_time" : 1700000600000,
"extract_running_flag" : "FINISHED"
} ],
"total_num" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。