文档首页/ 数据安全中心 DSC/ API参考/ API/ 大数据脱敏/ 获取ES任务模板下的所有任务 - ListBigdataTemplateTasks
更新时间:2026-10-20 GMT+08:00
分享

获取ES任务模板下的所有任务 - ListBigdataTemplateTasks

功能介绍

获取ES任务模板下的所有任务

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

template_id

是

String

参数解释:

模板ID,标识一个ES任务模板,用于查询该模板下的所有任务。可通过调用查询ES任务模板列表接口获取,或登录数据安全中心控制台的任务模板页面查看。

约束限制:

模板ID须为真实存在的模板

取值范围:

字符串类型,长度1~64字符

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

任务总数

取值范围:

不涉及

tasks

Array of DBMaskTaskInfo objects

参数解释:

ES脱敏任务列表

取值范围:

不涉及

表4 DBMaskTaskInfo

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

task_template_id

String

参数解释:

数据库脱敏任务信息ID

取值范围:

不涉及

db_type

String

参数解释:

数据库类型

取值范围:

不涉及

start_time

Long

参数解释:

数据库脱敏任务开始时间,任务计划或实际开始执行的时间点,毫秒级Unix时间戳。

取值范围:

整数,0~9223372036854775807

end_time

Long

参数解释:

数据库脱敏任务结束时间,任务执行结束的时间点,毫秒级Unix时间戳。

取值范围:

整数,0~9223372036854775807

run_status

String

参数解释:

运行状态

取值范围:

不涉及

progress

Integer

参数解释:

执行进度,表示数据库脱敏任务的执行进度百分比,取值0~100,100表示任务执行完成。

取值范围:

整数,0~100

type

String

参数解释:

脱敏任务类型

取值范围:

不涉及

error_msg

String

参数解释:

错误信息

取值范围:

不涉及

execute_line

Integer

参数解释:

执行行数

取值范围:

不涉及

请求示例

获取ES任务模板下的所有任务

/v1/2b31ed520abcd1234ebedb6e57123456/sdg/server/mask/bigdata/templates/0b02392f3d0042bd8f80376485d9b7d8/tasks

响应示例

状态码:200

{
  "total" : 1,
  "tasks" : [ {
    "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "task_template_id" : "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "db_type" : "ES",
    "start_time" : 1695110400000,
    "end_time" : 1695114000000,
    "run_status" : "FINISHED",
    "progress" : 100,
    "type" : "MASK",
    "error_msg" : ""
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档