获取扫描任务列表 - ListImageScanTask
功能介绍
获取扫描任务列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/image/tasks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
global_image_type |
否 |
String |
参数解释: 镜像类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
type |
是 |
String |
参数解释: 任务总类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
task_type |
否 |
String |
参数解释: 任务细分类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
task_name |
否 |
String |
参数解释: 模糊匹配任务名称 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
task_id |
否 |
String |
参数解释: 任务id 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
create_time |
否 |
Long |
参数解释: 任务创建时间,时间单位毫秒(ms) 约束限制: 不涉及 取值范围: 最小值0,最大值4070880000000 默认取值: 不涉及 |
|
end_time |
否 |
Long |
参数解释: 任务结束时间,时间单位毫秒(ms) 约束限制: 不涉及 取值范围: 最小值0,最大值4070880000000 默认取值: 不涉及 |
|
task_status |
否 |
String |
参数解释: 任务情况 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
scan_scope |
否 |
Integer |
参数解释: 扫描风险类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_list |
Array of ImageScanTaskInfo objects |
参数解释: task任务列表 取值范围: 最小值0,最大值1000 |
|
total_num |
Integer |
参数解释: 任务总数 取值范围: 最小值0,最大值1000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
参数解释: 任务ID 取值范围: 字符长度1-256位 |
|
policy_id |
String |
参数解释: 策略ID 取值范围: 字符长度1-256位 |
|
task_name |
String |
参数解释: 任务名称 取值范围: 字符长度1-256位 |
|
begin_time |
Long |
参数解释: 任务开始时间 取值范围: 最小值0,最大值9223372036854775807 |
|
end_time |
Long |
参数解释: 任务结束时间 取值范围: 最小值0,最大值9223372036854775807 |
|
remain_min |
Long |
参数解释: 任务剩余时间 取值范围: 最小值0,最大值2147483547 |
|
task_type |
String |
参数解释: 任务细分类型 取值范围:
|
|
image_type |
String |
参数解释: 镜像类型 取值范围:
|
|
task_status |
Integer |
参数解释: 扫描进度状态 取值范围:
|
|
scan_scope |
Integer |
参数解释: 扫描风险类型 取值范围:
|
|
rate_limit |
Integer |
参数解释: 扫描限速 单位:个/h 取值范围: 最小值0,最大值1000 |
|
is_all |
Boolean |
参数解释: 扫描全部镜像 取值范围:
|
|
failed_num |
Integer |
参数解释: 扫描失败镜像数量 取值范围: 最小值0,最大值2147483547 |
|
success_num |
Integer |
参数解释: 扫描成功镜像数量 取值范围: 最小值0,最大值2147483547 |
|
total_num |
Integer |
参数解释: 任务关联的镜像总数 取值范围: 最小值0,最大值2147483547 |
|
risky_num |
Integer |
参数解释: 有漏洞风险、基线风险、恶意文件的镜像总数 取值范围: 最小值0,最大值2147483547 |
|
sync_task_type |
String |
参数解释: 同步任务类型 取值范围: 字符长度1-256位 |
|
failed_reason |
String |
参数解释: 失败原因 取值范围: 字符长度0-128位 |
|
failed_images |
Array of failed_images objects |
参数解释: 失败镜像列表 取值范围: 最小值0,最大值2147483547 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Long |
参数解释: 失败镜像ID 取值范围: 最小值0,最大值9223372036854775807 |
|
registry_id |
String |
参数解释: 镜像仓库ID 取值范围: 字符长度0-128位 |
|
registry_name |
String |
参数解释: 镜像仓库名称 取值范围: 字符长度0-128位 |
|
image_name |
String |
参数解释: 镜像名称 取值范围: 字符长度0-128位 |
|
image_version |
String |
参数解释: 镜像版本 取值范围: 字符长度0-128位 |
|
namespace |
String |
参数解释: 命名空间 取值范围: 字符长度0-128位 |
|
registry_type |
String |
参数解释: 镜像仓库类型 取值范围:
|
|
failed_reason |
String |
参数解释: 失败原因 取值范围: 字符长度0-128位 |
请求示例
无
响应示例
状态码:200
请求已成功
{
"data_list" : [ {
"task_id" : "d5ceaaf4-0124-4f15-b039-b8fc4b07e340",
"task_name" : "镜像资产自动同步_1755536448006",
"begin_time" : 1755536448006,
"end_time" : 1755536451911,
"task_type" : "autoSync",
"task_status" : 100,
"failed_num" : 0,
"success_num" : 3,
"total_num" : 3,
"failed_images" : [ ]
} ],
"total_num" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。