# 创建镜像安全报告信息导出任务（支持全量/批量导出） - ExportImageSecurityReportTask #### 功能介绍 创建镜像安全报告信息导出任务（支持全量/批量导出）,支持导出恶意文件、软件信息、文件信息、敏感信息、软件合规、镜像构建指令风险。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v5/{project_id}/image/security-report/export-tasks 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0024.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释**: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见[获取企业项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0027.html)。 如需查询所有企业项目下的资产请传参"all_granted_eps"。 **约束限制**: 开通企业项目功能后才需要配置企业项目ID参数。 **取值范围**: 字符长度1-256位 **默认取值**: 0，表示默认企业项目（default）。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-32768位 **默认取值**: 不涉及 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | export_size | 是 | Integer | 导出数据条数 | | security_report_type | 是 | String | **参数解释**: 安全报告类型 **约束限制**: 不涉及 **取值范围**: - malwares : 恶意文件信息 - apps : 软件信息 - files : 文件信息 - sensitive-info : 敏感信息 - non-compliant-app : 软件合规信息 - build-command-risks : 镜像构建指令风险 | | image_id_list | 否 | Array of strings | 要导出的镜像id列表。operate_all参数为false时,需要填写此批量查询条件。本地/CICD镜像填写image_id，仓库镜像填写镜像列表返回的id | | operate_all | 是 | Boolean | 若为true表示查询全量镜像，可传其他参数对全量镜像数据进行筛选 | | image_type | 否 | String | **参数解释**: 镜像类型。导出本地镜像和cicd镜像报告时，需要传参image_type。不传此参数时，默认导出其他仓库镜像数据。 **约束限制**: 不涉及 **取值范围**: - private_image : 私有镜像 - shared_image : 共享镜像 - local_image : 本地镜像 - instance_image : 企业镜像 - harbor : Harbor镜像 - jfrog : Jfrog镜像 - cicd : cicd镜像 | | scan_status | 否 | String | 扫描状态，包含如下: - unscan : 未扫描 - success : 扫描完成 - scanning : 扫描中 - failed : 扫描失败 - download_failed : 下载失败 - image_oversized : 镜像超大 | | 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 | 是否有安全风险，包含如下: - true : 有风险 - false : 无风险 | | severity_level | 否 | String | 镜像风险程度，在镜像扫描完成后展示，包含如下： - Security：安全 - Low：低危 - Medium：中危 - High：高危 | | instance_name | 否 | String | 企业镜像实例名称 | | cicd_name | 否 | String | cicd名称 | | build_command_risk_level | 否 | String | **参数解释**: 构建指令风险程度 **约束限制**: 不涉及 **取值范围**: - critical ：严重 - high ：高危 - medium ：中危 - low ：低危 **默认取值**: 不涉及 | | build_command_risk_name | 否 | String | 构建指令风险名称 | | build_command_rule_id_list | 否 | Array of strings | 要导出的构建指令风险检测规则id列表。rule_id的值可以从接口/v5/{project_id}/image/build-command-risks的返回参数获取 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | 导出任务ID | #### 请求示例 ``` { "operate_all" : true, "export_size" : 100, "security_report_type" : "malwares" } ``` #### 响应示例 **状态码：200** 请求已成功 ``` { "task_id" : "asdwwqdtut01" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ExportImageSecurityReportTaskSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("")) .build(); ExportImageSecurityReportTaskRequest request = new ExportImageSecurityReportTaskRequest(); try { ExportImageSecurityReportTaskResponse response = client.exportImageSecurityReportTask(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("")) \ .build() try: request = ExportImageSecurityReportTaskRequest() response = client.export_image_security_report_task(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.ExportImageSecurityReportTaskRequest{} response, err := client.ExportImageSecurityReportTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ExportImageSecurityReportTask&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。