# 获取数据水印提取任务列表 - ListDbExtractTasks #### 功能介绍 功能介绍：分页查询数据水印提取任务列表，返回任务状态、水印提取结果等信息。 #### 接口约束 - 无特殊约束。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/data-watermark-extract-tasks 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，长度为32个字符，满足正则匹配"\^\[a-z0-9\]{32}$" **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | Array of [TaskDetail] objects | **参数解释：** 提取任务结果列表 **取值范围：** 不涉及 result项 不涉及 **取值范围：** 不涉及 不涉及' | | total_num | Long | **参数解释：** 提取结果总数 **取值范围：** 最小值0，最大值2147483647 | | id | Long | **参数解释：** 资源ID，唯一标识 **取值范围：** 最小值0，最大值2147483647 | | task_name | String | **参数解释：** 数据库水印提取响应名称 **取值范围：** 不涉及 | | file_name | String | **参数解释：** 水印提取文件名称，标识待进行水印提取的目标文件名称，用于定位需要提取水印的数据文件。 **取值范围：** 字符串类型，长度1\~128字符 | | water_describe | String | **参数解释：** 水印描述 **取值范围：** 不涉及 | | water_extract_result | String | **参数解释：** 水印提取结果 **取值范围：** 不涉及 | | error_msg | String | **参数解释：** 错误信息 **取值范围：** 不涉及 | | task_create_time | Long | **参数解释：** 任务创建时间，水印提取任务创建的时间点，毫秒级Unix时间戳。 **取值范围：** 整数，0\~9999999999999 | | task_end_time | Long | **参数解释：** 任务结束时间，水印提取任务执行结束的时间点，毫秒级Unix时间戳。 **取值范围：** 整数，0\~9999999999999 | | extract_running_flag | String | **参数解释：** 提取任务运行状态标识 **取值范围：** 不涉及 | 表4TaskDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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表示任务执行过程中出现错误。 **取值范围：** 整数，0\~2147483647 | | water_mark | String | **参数解释：** 水印内容 **取值范围：** 不涉及 | | watermark_version | String | **参数解释：** 水印版本 **取值范围：** 不涉及 | | watermark_describe | 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" : 0, "water_mark" : "dsc-embed-watermark-01", "watermark_version" : "VERSION_1", "watermark_describe" : "客户数据水印嵌入" } ], "total_num" : 1, "id" : 1001, "task_name" : "extract-task-01", "file_name" : "financial-report.pdf", "water_describe" : "客户数据水印提取", "water_extract_result" : "asset-owner-001", "error_msg" : "任务执行成功", "task_create_time" : 1700000000000, "task_end_time" : 1700000600000, "extract_running_flag" : "FINISHED_STATE" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。