创建扫描任务 - CreateManualImageScanTask
功能介绍
创建扫描任务
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/image/image-scan/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 |
参数解释: 镜像类型 约束限制: 不涉及 取值范围:
默认取值: registry |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
region |
否 |
String |
参数解释: 区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID。 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
scan_scope |
否 |
Integer |
参数解释: 扫描风险类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
rate_limit |
否 |
Integer |
参数解释: 扫描限速 单位:个/h 约束限制: 不涉及 取值范围: 0-1000,0表示不限制。 默认取值: 不涉及 |
|
is_all |
否 |
Boolean |
参数解释: 扫描全部镜像 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
query_info |
否 |
query_info object |
按照查询结果扫描 |
|
image_info |
否 |
Array of image_info objects |
待扫描镜像 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
local_image_type |
否 |
String |
参数解释: 本地镜像类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
host_id |
否 |
String |
参数解释: 服务器ID 约束限制: 不涉及 取值范围: 字符长度0-128位。 默认取值: 不涉及 |
|
host_name |
否 |
String |
参数解释: 服务器名称 约束限制: 不涉及 取值范围: 字符长度0-128位。 默认取值: 不涉及 |
|
public_ip |
否 |
String |
参数解释: 服务器公网IP 约束限制: 不涉及 取值范围: 字符长度0-128位。 默认取值: 不涉及 |
|
private_ip |
否 |
String |
参数解释: 私有IP地址 约束限制: 不涉及 取值范围: 字符长度0-128位。 默认取值: 不涉及 |
|
cluster_id |
否 |
String |
参数解释: 集群id 约束限制: 不涉及 取值范围: 字符长度0-128位。 默认取值: 不涉及 |
|
container_id |
否 |
String |
参数解释: 容器id 约束限制: 不涉及 取值范围: 字符长度0-128位。 默认取值: 不涉及 |
|
container_name |
否 |
String |
参数解释: 容器名称 约束限制: 不涉及 取值范围: 字符长度0-128位。 默认取值: 不涉及 |
|
pod_id |
否 |
String |
参数解释: pod id 约束限制: 不涉及 取值范围: 字符长度0-64位。 默认取值: 不涉及 |
|
pod_name |
否 |
String |
参数解释: pod 名称 约束限制: 不涉及 取值范围: 字符长度0-512位。 默认取值: 不涉及 |
|
app_name |
否 |
String |
参数解释: 软件名称 约束限制: 不涉及 取值范围: 字符长度0-256位。 默认取值: 不涉及 |
|
has_vul |
否 |
Boolean |
参数解释: 是否存在软件漏洞 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
namespace |
否 |
String |
参数解释: 组织名称 约束限制: 不涉及 取值范围: 字符长度0-256位。 默认取值: 不涉及 |
|
image_name |
否 |
String |
参数解释: 镜像名称 约束限制: 不涉及 取值范围: 字符长度0-256位。 默认取值: 不涉及 |
|
image_version |
否 |
String |
参数解释: 镜像版本 约束限制: 不涉及 取值范围: 字符长度0-256位。 默认取值: 不涉及 |
|
image_type |
否 |
String |
参数解释: 镜像类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
scan_status |
否 |
String |
参数解释: 扫描状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
image_size |
否 |
Long |
参数解释: 镜像大小 约束限制: 不涉及 取值范围: 0-9223372036854775807。 默认取值: 不涉及 |
|
start_latest_update_time |
否 |
Long |
参数解释: 创建时间开始日期,时间单位 毫秒(ms) 约束限制: 不涉及 取值范围: 0-9223372036854775807。 默认取值: 不涉及 |
|
end_latest_update_time |
否 |
Long |
参数解释: 创建时间结束日期,时间单位 毫秒(ms) 约束限制: 不涉及 取值范围: 0-9223372036854775807。 默认取值: 不涉及 |
|
start_latest_scan_time |
否 |
Long |
参数解释: 最近一次扫描完成时间开始日期,时间单位 毫秒(ms) 约束限制: 不涉及 取值范围: 0-9223372036854775807。 默认取值: 不涉及 |
|
end_latest_scan_time |
否 |
Long |
参数解释: 最近一次扫描完成时间结束日期,时间单位 毫秒(ms) 约束限制: 不涉及 取值范围: 0-9223372036854775807。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
Long |
id |
|
image_id |
否 |
String |
image id |
|
image_digest |
否 |
String |
镜像digest |
|
registry_id |
否 |
String |
镜像仓库ID |
|
registry_name |
否 |
String |
镜像仓库名称 |
|
image_name |
否 |
String |
镜像名称 |
|
image_version |
否 |
String |
镜像版本 |
|
namespace |
否 |
String |
命名空间 |
|
instance_id |
否 |
String |
企业实例ID |
|
instance_url |
否 |
String |
下载企业镜像URL |
|
registry_type |
否 |
String |
参数解释: 镜像仓库类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
响应参数
状态码:200
请求已成功
无
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。