文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 镜像仓库基线检查批量导出(支持全量导出) - BatchExportBaselineTask
更新时间:2025-12-26 GMT+08:00
分享

镜像仓库基线检查批量导出(支持全量导出) - BatchExportBaselineTask

功能介绍

镜像仓库基线检查批量导出(支持全量导出),若导出镜像类型为cicd类型的数据,需要传参image_type为cicd。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/image/baseline/export

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

export_size

Integer

参数解释:

导出数据条数

约束限制:

不涉及

取值范围:

最小值0,最大值2147483647

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

image_id_list

Array of strings

参数解释:

要导出的镜像信息列表,operate_all参数为false时需要填写批量查询条件,image_id 镜像id,唯一镜像标识(注:对私有镜像和共享镜像来说是镜像列表返回的id)

约束限制:

不涉及

取值范围:

最小值0,最大值2147483647

默认取值:

不涉及

operate_all

Boolean

参数解释

若为true全量查询,可筛选条件全部查询

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

image_type

String

参数解释:

镜像类型

约束限制:

不涉及

取值范围:

  • private_image: 私有镜像。

  • shared_image: 共享镜像。

  • local_image: 本地镜像。

  • instance_image: 企业镜像。

  • harbor: Harbor镜像。

  • jfrog: Jfrog镜像。

  • cicd: cicd镜像。

默认取值:

不涉及

vul_type

String

参数解释:

漏洞类型

约束限制:

不涉及

取值范围:

  • linux_vul : linux漏洞。

  • app_vul : 应用漏洞。

默认取值:

不涉及

scan_status

String

参数解释:

扫描状态

约束限制:

不涉及

取值范围:

  • unscan: 未扫描。

  • success: 扫描完成。

  • scanning: 扫描中。

  • failed: 扫描失败。

  • download_failed: 下载失败。

  • image_oversized: 镜像超大。

默认取值:

不涉及

namespace

String

参数解释:

组织名称(只有私有镜像和共享镜像有该字段,本地镜像没有)

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

image_name

String

参数解释:

镜像名称

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

image_version

String

参数解释:

镜像版本名称

约束限制:

不涉及

取值范围:

字符长度0-65535位

默认取值:

不涉及

image_id

String

参数解释:

镜像id

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

latest_version

Boolean

参数解释

仅关注最新版本镜像

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

image_size

Long

参数解释:

镜像大小

约束限制:

不涉及

取值范围:

最小值0,最大值2147483547

默认取值:

不涉及

start_latest_update_time

Long

参数解释:

创建时间开始日期,时间单位 毫秒(ms)

约束限制:

不涉及

取值范围:

最小值0,最大值2147483547

默认取值:

不涉及

end_latest_update_time

Long

参数解释:

创建时间结束日期,时间单位 毫秒(ms)

约束限制:

不涉及

取值范围:

最小值0,最大值2147483547

默认取值:

不涉及

start_latest_scan_time

Long

参数解释:

最近一次扫描完成时间开始日期,时间单位 毫秒(ms)

约束限制:

不涉及

取值范围:

最小值0,最大值2147483547

默认取值:

不涉及

end_latest_scan_time

Long

参数解释:

最近一次扫描完成时间结束日期,时间单位 毫秒(ms)

约束限制:

不涉及

取值范围:

最小值0,最大值2147483547

默认取值:

不涉及

has_malicious_file

Boolean

参数解释

是否存在恶意文件

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

has_vul

Boolean

参数解释

是否存在软件漏洞

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

has_unsafe_setting

Boolean

参数解释

是否存在基线检查

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

risky

Boolean

参数解释

是否有安全风险

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

severity_level

String

参数解释:

镜像风险程度,在镜像扫描完成后展示

约束限制:

不涉及

取值范围:

  • Security : 安全。

  • Low : 低危。

  • Medium : 中危。

  • High : 高危。

默认取值:

不涉及

instance_name

String

参数解释:

企业镜像实例名称

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

instance_id

String

参数解释:

企业仓库实例ID

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

cicd_name

String

参数解释:

cicd名称

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

build_command_risk_level

String

参数解释:

构建指令风险程度

约束限制:

不涉及

取值范围:

  • critical :严重。

  • high :高危。

  • medium :中危。

  • low :低危。

默认取值:

不涉及

build_command_risk_name

String

参数解释:

构建指令风险名称

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

build_command_rule_id_list

Array of strings

参数解释:

要导出的构建指令风险检测规则id列表。rule_id的值可以从接口/v5/{project_id}/image/build-command-risks的返回参数获取

约束限制:

不涉及

取值范围:

字符长度1-200位

默认取值:

不涉及

has_container

Boolean

参数解释

是否存在容器

约束限制:

不涉及

取值范围

  • true:是。

  • false:否。

默认取值:

不涉及

vul_id_list

Array of strings

参数解释:

导出镜像漏洞时的漏洞id列表

约束限制:

不涉及

取值范围:

最小值0,最大值2048

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

record_total_num

Long

参数解释:

导出记录总数

取值范围:

最小值0,最大值2147483647

task_id

String

参数解释:

导出任务ID

取值范围:

字符长度1-256位

请求示例

{
  "operate_all" : true
}

响应示例

状态码:200

请求已成功

{
  "record_total_num" : 1,
  "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 BatchExportBaselineTaskSolution {

    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();
        BatchExportBaselineTaskRequest request = new BatchExportBaselineTaskRequest();
        BatchExportSWRBaselineInfoRequestInfo body = new BatchExportSWRBaselineInfoRequestInfo();
        request.withBody(body);
        try {
            BatchExportBaselineTaskResponse response = client.batchExportBaselineTask(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 = BatchExportBaselineTaskRequest()
        request.body = BatchExportSWRBaselineInfoRequestInfo(
        )
        response = client.batch_export_baseline_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.BatchExportBaselineTaskRequest{}
	request.Body = &model.BatchExportSwrBaselineInfoRequestInfo{
	}
	response, err := client.BatchExportBaselineTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档