文档首页/ 数据安全中心 DSC/ API参考/ API/ 风险评估/ 获取指定任务进度 - ListRiskAssessmentTasks
更新时间:2026-11-13 GMT+08:00
分享

获取指定任务进度 - ListRiskAssessmentTasks

功能介绍

功能介绍:查询数据健康检查任务进度列表,按 offset 定位任务并返回其进度(每次最多返回 1 条任务),同时返回是否允许创建新任务。

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/dsc/data-health-check/task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

满足正则匹配"^[a-z0-9]{32}$",即32位小写字母和数字组合。

取值范围:

以IAM服务接口返回值为准,由数字和字母组成,长度为32个字符。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

分页偏移

约束限制:

≥0,且 offset + limit ≤ 1000000

取值范围:

≥0

默认取值:

0

limit

否

Integer

参数解释:

每页数量限制

约束限制:

1~10000,且 offset + limit ≤ 1000000

取值范围:

1~10000

默认取值:

1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

allow_create

Boolean

参数解释:

是否允许创建新任务(当天未创建过任务或上次任务失败时为 true)

取值范围:

true-是,false-否

total

Integer

参数解释:

总记录数

取值范围:

不涉及

task_infos

Array of DataTaskInfo objects

参数解释:

任务信息列表

取值范围:

不涉及

表5 DataTaskInfo

参数

参数类型

描述

task_id

String

参数解释:

任务ID

取值范围:

不涉及

status

String

参数解释:

任务状态

取值范围:

READY-待执行、RUNNING-执行中、FINISH-已完成、FAIL-失败

step

String

参数解释:

任务步骤

取值范围:

CREATE_READONLY_DB_USER、CHECK_DB_CONNECTION、INSERT_SCAN_JOB、WAIT_SCAN_JOB、CHECK_DB_SECURITY_CONFIG、STATISTICS_RESULT、DELETE_OK_INFO、DELETE_FAIL_INFO

progress

Integer

参数解释:

任务进度,单位为百分比,取值0~100,表示任务执行的完成度

取值范围:

不涉及

create_time

Long

参数解释:

创建时间,Unix时间戳,单位为毫秒,表示任务创建的时间点

取值范围:

不涉及

finish_time

Long

参数解释:

完成时间,Unix时间戳,单位为毫秒,表示任务完成的时间点

取值范围:

不涉及

请求示例

获取数据健康检查任务进度

/v1/2b31ed520aabbccddeedb6e571234567/dsc/data-health-check/task

响应示例

状态码:200

{
  "allow_create" : false,
  "total" : 1,
  "task_infos" : [ {
    "task_id" : "task-0b02392f3d0042bd8f80376485d9b7d8",
    "status" : "FINISH",
    "step" : "STATISTICS_RESULT",
    "progress" : 100,
    "create_time" : 1787306400000,
    "finish_time" : 1787309600000
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档