文档首页/ 数据安全中心 DSC/ API参考/ API/ API数据安全网关/ 查询扫描任务 - ShowSecurityGovernanceTasks
更新时间:2026-10-09 GMT+08:00
分享

查询扫描任务 - ShowSecurityGovernanceTasks

功能介绍

功能介绍:查询扫描任务

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/sdg/server/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

job_name

否

String

参数解释:

扫描任务名称

约束限制:

最大长度128字符

取值范围:

不涉及

默认取值:

不涉及

limit

否

Integer

参数解释:

查询分页每页数量

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

jobs

Array of Jobs objects

参数解释:

任务作业列表

取值范围:

不涉及

job_name

String

参数解释:

任务作业名称

取值范围:

不涉及

tasks

Array of Tasks objects

参数解释:

子任务列表

取值范围:

不涉及

task_id

String

参数解释:

任务响应ID

取值范围:

不涉及

run_status

String

参数解释:

任务运行状态

取值范围:

  • "READY" 初始

  • "INIT" 初始化中

  • "WAITING" 排队中

  • "RUNNING" 处理中

  • "FINISHED" 完成

  • "FAILED" 失败

  • "TERMINATED" 前台已终止

  • "STOPPED" 已停止

start_time

Long

参数解释:

任务启动时间(时间戳)

取值范围:

不涉及

total_objects

Integer

参数解释:

待扫描对象总数

取值范围:

不涉及

scaned_objects

Integer

参数解释:

已扫描对象数

取值范围:

不涉及

progress

Integer

参数解释:

扫描进度百分比

取值范围:

不涉及

表5 Jobs

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

表6 Tasks

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

请求示例

查询扫描任务请求体

{
  "job_name" : "customer-db-scan-01",
  "limit" : 50
}

响应示例

状态码:200

{
  "total" : 1,
  "jobs" : [ {
    "total" : 1
  } ],
  "job_name" : "customer-db-scan-01",
  "tasks" : [ {
    "total" : 1
  } ],
  "task_id" : "b3c4d5e6-7f8a-4b9c-0d1e-2f3a4b5c6d7e",
  "run_status" : "FINISHED",
  "start_time" : 1700000000000,
  "total_objects" : 5,
  "scaned_objects" : 5,
  "progress" : 100
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档