文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 通用任务模块/ 查询任务列表 - ListTasks
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查询任务列表 - ListTasks

功能介绍

查询任务列表

授权信息

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

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

URI

POST /v5/{project_id}/common/tasks/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0，表示默认企业项目（default）。

offset

否

Integer

参数解释:

偏移量：指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0，最大值2000000

默认取值:

默认为0

limit

否

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及
表4 请求Body参数

参数

是否必选

参数类型

描述

task_type

是

String

任务类型，包含如下

  • cluster_scan：集群扫描

  • iac_scan：iac扫描

task_id

否

String

本次创建任务的id

task_name

否

String

模糊匹配任务名称

start_create_time

否

Long

按任务创建时间范围查询时的起始时间

end_create_time

否

Long

按任务创建时间范围查询时的结束时间

trigger_type

否

String

任务触发类型，包含如下

  • manual：手动创建的任务

  • schedule：定时任务

task_status

否

String

任务状态，包含如下

  • ready：等待执行

  • running：运行中

  • finished：任务结束

sort_key

否

String

排序字段，包含如下

  • start_time：任务开始时间

sort_dir

否

String

排序方式，包含如下

  • desc：降序

  • asc: 升序

cluster_scan_info

否

cluster_scan_info object

集群扫描任务的参数，任务类型task_type为“cluster_scan”时可传

iac_scan_info

否

iac_scan_info object

IAC安全扫描任务的参数，任务类型task_type为“iac_scan”时可传
表5 cluster_scan_info

参数

是否必选

参数类型

描述

scan_type_list

否

Array of strings

参数解释:

任务扫描项类型列表，若列表不为空则只有扫描了列表中所有扫描项的任务才会被筛选出来；列表为空则不对扫描项类型进行筛选

约束限制:

不涉及

取值范围:

  • cluster_vul：集群漏洞

  • risk_assessment：风险评估

  • benchmark：安全合规

默认取值:

不涉及
表6 iac_scan_info

参数

是否必选

参数类型

描述

file_type

否

String

文件类型，包含如下

  • dockerfile：Dockerfile文件

  • k8s_yaml：k8s yaml文件

响应参数

状态码：200

表7 响应Body参数

参数

参数类型

描述

total_num

Integer

任务列表数量

data_list

Array of data_list objects

任务列表
表8 data_list

参数

参数类型

描述

task_id

String

本次创建任务的id

task_type

String

任务类型，包含如下

  • cluster_scan：集群扫描

  • iac_scan：iac扫描

task_name

String

任务名称

trigger_type

String

任务触发类型，包含如下

  • manual：手动创建的任务

  • schedule：定时任务

task_status

String

任务状态，包含如下

  • ready：等待执行

  • running：运行中

  • finished：任务结束

start_time

Long

任务开始的时间

end_time

Long

任务结束的时间

estimated_time

Integer

预计当前任务结束还需要的时间，单位为分钟

cluster_scan_info

cluster_scan_info object

集群扫描任务特有的任务信息

iac_scan_info

iac_scan_info object

IAC安全扫描任务特有的任务信息
表9 cluster_scan_info

参数

参数类型

描述

scan_type_list

Array of strings

本次扫描任务涉及的扫描项类型列表

scanning_cluster_num

Integer

当前任务处于扫描中的集群数量

success_cluster_num

Integer

当前任务扫描成功的集群数量

failed_cluster_num

Integer

当前任务扫描失败的集群数量
表10 iac_scan_info

参数

参数类型

描述

file_type

String

文件类型，包含如下

  • dockerfile：Dockerfile文件

  • k8s_yaml：k8s yaml文件

scan_file_num

Integer

当前任务扫描的文件总数

success_file_num

Integer

当前任务扫描成功的文件数量

failed_file_num

Integer

当前任务扫描失败的文件数量

请求示例

查询project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的所有集群扫描任务

POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/common/tasks/batch-query?enterprise_project_id=all_granted_eps

{
  "task_type" : "cluster_scan"
}

响应示例

状态码：200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "task_id" : "d8xxxx05-8xx5-4xx0-9xx6-c3dbxxxxxxac",
    "task_type" : "cluster_scan",
    "trigger_type" : "manual",
    "task_status" : "running",
    "start_time" : 1745311451000,
    "end_time" : 1745311451000,
    "estimated_time" : 5,
    "cluster_scan_info" : {
      "scan_type_list" : [ "cluster_vul" ],
      "scanning_cluster_num" : 2,
      "success_cluster_num" : 1,
      "failed_cluster_num" : 1
    }
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 通用任务模块

相关文档