文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据脱敏/ 获取任务列表 - ListTasks
更新时间:2026-10-09 GMT+08:00
分享

获取任务列表 - ListTasks

功能介绍

获取任务列表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/sdg/server/mask/dbs/templates/{template_id}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

template_id

是

String

参数解释:

模板ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

workspace_id

否

String

参数解释:

工作空间ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

tasks

Array of DBMaskTaskInfo objects

参数解释:

脱敏任务列表

取值范围:

不涉及

表5 DBMaskTaskInfo

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

task_template_id

String

参数解释:

数据库脱敏任务信息ID

取值范围:

不涉及

db_type

String

参数解释:

数据库类型

取值范围:

不涉及

start_time

Long

参数解释:

数据库脱敏任务信息时间

取值范围:

不涉及

end_time

Long

参数解释:

数据库脱敏任务信息时间

取值范围:

不涉及

run_status

String

参数解释:

运行状态

取值范围:

不涉及

progress

Integer

参数解释:

执行进度

取值范围:

不涉及

type

String

参数解释:

脱敏任务类型

取值范围:

不涉及

error_msg

String

参数解释:

错误信息

取值范围:

不涉及

execute_line

Integer

参数解释:

执行行数

取值范围:

不涉及

请求示例

获取任务列表

/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/sdg/server/mask/dbs/templates/xxxx-xxxx-xxxx-xxxx/tasks

响应示例

状态码:200

{
  "total" : 1,
  "tasks" : [ {
    "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "task_template_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "db_type" : "MYSQL",
    "start_time" : 1700000000000,
    "end_time" : 1700000600000,
    "run_status" : "FINISHED",
    "progress" : 100,
    "type" : "DB",
    "error_msg" : "任务执行成功",
    "execute_line" : 1000
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档