文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器安装与配置/ 创建镜像安全报告信息导出任务(支持全量/批量导出)
更新时间:2025-08-15 GMT+08:00

创建镜像安全报告信息导出任务(支持全量/批量导出)

功能介绍

创建镜像安全报告信息导出任务(支持全量/批量导出),支持导出恶意文件、软件信息、文件信息、敏感信息、软件合规、镜像构建指令风险。

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/image/security-report/export-tasks

表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)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度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代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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("<YOUR REGION>"))
                .build();
        ExportImageSecurityReportTaskRequest request = new ExportImageSecurityReportTaskRequest();
        ExportImageSecurityReportTaskRequestInfo body = new ExportImageSecurityReportTaskRequestInfo();
        request.withBody(body);
        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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = ExportImageSecurityReportTaskRequest()
        request.body = ExportImageSecurityReportTaskRequestInfo(
        )
        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)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ExportImageSecurityReportTaskRequest{}
	request.Body = &model.ExportImageSecurityReportTaskRequestInfo{
	}
	response, err := client.ExportImageSecurityReportTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码