创建镜像安全报告信息导出任务（支持全量/批量导出） - ExportImageSecurityReportTask
功能介绍
创建镜像安全报告信息导出任务（支持全量/批量导出）,支持导出恶意文件、软件信息、文件信息、敏感信息、软件合规、镜像构建指令风险。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/image/security-report/export-tasks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
export_size |
是 |
Integer |
导出数据条数 |
|
security_report_type |
是 |
String |
参数解释: 安全报告类型 约束限制: 不涉及 取值范围:
|
|
image_id_list |
否 |
Array of strings |
要导出的镜像id列表。operate_all参数为false时,需要填写此批量查询条件。本地/CICD镜像填写image_id，仓库镜像填写镜像列表返回的id |
|
operate_all |
是 |
Boolean |
若为true表示查询全量镜像，可传其他参数对全量镜像数据进行筛选 |
|
image_type |
否 |
String |
参数解释: 镜像类型。导出本地镜像和cicd镜像报告时，需要传参image_type。不传此参数时，默认导出其他仓库镜像数据。 约束限制: 不涉及 取值范围:
|
|
scan_status |
否 |
String |
扫描状态，包含如下:
|
|
namespace |
否 |
String |
组织名称 |
|
image_name |
否 |
String |
镜像名称 |
|
image_version |
否 |
String |
镜像版本 |
|
image_id |
否 |
String |
镜像id |
|
latest_version |
否 |
Boolean |
仅关注最新版本镜像 |
|
image_size |
否 |
Long |
镜像大小 |
|
start_latest_update_time |
否 |
Long |
创建时间开始日期，时间单位：毫秒（ms） |
|
end_latest_update_time |
否 |
Long |
创建时间结束日期，时间单位：毫秒（ms） |
|
start_latest_scan_time |
否 |
Long |
最近一次扫描完成时间开始日期，时间单位：毫秒（ms） |
|
end_latest_scan_time |
否 |
Long |
最近一次扫描完成时间结束日期，时间单位：毫秒（ms） |
|
has_malicious_file |
否 |
Boolean |
是否存在恶意文件 |
|
has_vul |
否 |
Boolean |
是否存在软件漏洞 |
|
has_unsafe_setting |
否 |
Boolean |
是否存在基线检查 |
|
risky |
否 |
Boolean |
是否有安全风险，包含如下:
|
|
severity_level |
否 |
String |
镜像风险程度，在镜像扫描完成后展示，包含如下：
|
|
instance_name |
否 |
String |
企业镜像实例名称 |
|
cicd_name |
否 |
String |
cicd名称 |
|
build_command_risk_level |
否 |
String |
参数解释: 构建指令风险程度 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
build_command_risk_name |
否 |
String |
构建指令风险名称 |
|
build_command_rule_id_list |
否 |
Array of strings |
要导出的构建指令风险检测规则id列表。rule_id的值可以从接口/v5/{project_id}/image/build-command-risks的返回参数获取 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
导出任务ID |
请求示例
{
"operate_all" : true,
"export_size" : 100,
"security_report_type" : "malwares"
}
响应示例
状态码：200
请求已成功
{
"task_id" : "asdwwqdtut01"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
