文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器镜像/ 镜像仓库镜像批量扫描

更新时间：2024-07-04 GMT+08:00

在线调试

CLI示例

查看PDF

镜像仓库镜像批量扫描

功能介绍

镜像仓库镜像批量扫描

调用方法

请参见如何调用API。

URI

POST /v5/{project_id}/image/batch-scan

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID 最小长度：1 最大长度：256

表2 Query参数
参数	是否必选	参数类型	描述
enterprise_project_id	否	String	企业项目ID，查询所有企业项目时填写：all_granted_eps 缺省值：0 最小长度：1 最大长度：256

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）最小长度：1 最大长度：32768
region	否	String	Region ID 最小长度：0 最大长度：128

表4 请求Body参数
参数	是否必选	参数类型	描述
repo_type	否	String	仓库类型，现阶段接入了swr镜像仓库，包含如下: SWR : SWR镜像仓库最小长度：1 最大长度：32
image_info_list	否	Array of BatchScanSwrImageInfo objects	要扫描的镜像信息列表，operate_all参数为false时为必填数组长度：0 - 10241
operate_all	否	Boolean	若为true全量查询，可筛选条件全部查询，若image_info_list为空，则必填
namespace	否	String	组织名称最小长度：1 最大长度：256
image_name	否	String	镜像名称最小长度：1 最大长度：256
image_version	否	String	镜像版本最小长度：1 最大长度：256
image_type	是	String	镜像类型，包含如下: private_image : 私有镜像仓库 shared_image : 共享镜像仓库最小长度：1 最大长度：32
scan_status	否	String	扫描状态，包含如下: unscan : 未扫描 success : 扫描完成 scanning : 扫描中 failed : 扫描失败 download_failed : 下载失败 image_oversized : 镜像超大最小长度：1 最大长度：32
latest_version	否	Boolean	仅关注最新版本镜像
image_size	否	Long	镜像大小最小值：0 最大值：2147483547 缺省值：0
start_latest_update_time	否	Long	创建时间开始日期，时间单位毫秒（ms）最小值：0 最大值：2147483547 缺省值：0
end_latest_update_time	否	Long	创建时间结束日期，时间单位毫秒（ms）最小值：0 最大值：2147483547 缺省值：0
start_latest_scan_time	否	Long	最近一次扫描完成时间开始日期，时间单位毫秒（ms）最小值：0 最大值：2147483547 缺省值：0
end_latest_scan_time	否	Long	最近一次扫描完成时间结束日期，时间单位毫秒（ms）最小值：0 最大值：2147483547 缺省值：0

表5 BatchScanSwrImageInfo
参数	是否必选	参数类型	描述
namespace	否	String	命名空间最小长度：1 最大长度：64
image_name	否	String	镜像名称最小长度：1 最大长度：128
image_version	否	String	镜像版本最小长度：1 最大长度：128
instance_id	否	String	企业实例ID 最小长度：1 最大长度：128
instance_url	否	String	下载企业镜像URL 最小长度：0 最大长度：256

响应参数

无

请求示例

类型为私有镜像的镜像进行批量扫描，body体传参镜像列表，operate_all没有传参，说明需要镜像列表批量扫描。

POST https://{endpoint}/v5/{project_id}/image/batch-scan

{
  "image_type" : "private_image",
  "image_info_list" : [ {
    "image_name" : "openjdk",
    "image_version" : "v8.8",
    "namespace" : "test"
  }, {
    "image_name" : "openjdk1",
    "image_version" : "v1.0",
    "namespace" : "test1"
  } ]
}

类型为私有镜像的镜像进行全量扫描，body体没有传参镜像列表，operate_all=true，说明需要镜像列表全量扫描。
```
POST https://{endpoint}/v5/{project_id}/image/batch-scan

{
  "image_type" : "private_image",
  "operate_all" : true
}
```

响应示例

无

SDK代码示例

SDK代码示例如下。

类型为私有镜像的镜像进行批量扫描，body体传参镜像列表，operate_all没有传参，说明需要镜像列表批量扫描。

        
         
           
           
             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.*;

import java.util.List;
import java.util.ArrayList;

public class BatchScanSwrImageSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchScanSwrImageRequest request = new BatchScanSwrImageRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        BatchScanPrivateImageRequestInfo body = new BatchScanPrivateImageRequestInfo();
        List<BatchScanSwrImageInfo> listbodyImageInfoList = new ArrayList<>();
        listbodyImageInfoList.add(
            new BatchScanSwrImageInfo()
                .withNamespace("test")
                .withImageName("openjdk")
                .withImageVersion("v8.8")
        );
        listbodyImageInfoList.add(
            new BatchScanSwrImageInfo()
                .withNamespace("test1")
                .withImageName("openjdk1")
                .withImageVersion("v1.0")
        );
        body.withImageType("private_image");
        body.withImageInfoList(listbodyImageInfoList);
        request.withBody(body);
        try {
            BatchScanSwrImageResponse response = client.batchScanSwrImage(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());
        }
    }
}

            

          

        
       

类型为私有镜像的镜像进行全量扫描，body体没有传参镜像列表，operate_all=true，说明需要镜像列表全量扫描。

        
         
           
           
             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 BatchScanSwrImageSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchScanSwrImageRequest request = new BatchScanSwrImageRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        BatchScanPrivateImageRequestInfo body = new BatchScanPrivateImageRequestInfo();
        body.withImageType("private_image");
        body.withOperateAll(true);
        request.withBody(body);
        try {
            BatchScanSwrImageResponse response = client.batchScanSwrImage(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());
        }
    }
}

            

          

        
       

类型为私有镜像的镜像进行批量扫描，body体传参镜像列表，operate_all没有传参，说明需要镜像列表批量扫描。

        
         
           
           
             # 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"]

    credentials = BasicCredentials(ak, sk)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchScanSwrImageRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        listImageInfoListbody = [
            BatchScanSwrImageInfo(
                namespace="test",
                image_name="openjdk",
                image_version="v8.8"
            ),
            BatchScanSwrImageInfo(
                namespace="test1",
                image_name="openjdk1",
                image_version="v1.0"
            )
        ]
        request.body = BatchScanPrivateImageRequestInfo(
            image_type="private_image",
            image_info_list=listImageInfoListbody
        )
        response = client.batch_scan_swr_image(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

类型为私有镜像的镜像进行全量扫描，body体没有传参镜像列表，operate_all=true，说明需要镜像列表全量扫描。

        
         
           
           
             # 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"]

    credentials = BasicCredentials(ak, sk)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchScanSwrImageRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.body = BatchScanPrivateImageRequestInfo(
            image_type="private_image",
            operate_all=True
        )
        response = client.batch_scan_swr_image(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

类型为私有镜像的镜像进行批量扫描，body体传参镜像列表，operate_all没有传参，说明需要镜像列表批量扫描。

        
         
           
           
             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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

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

    request := &model.BatchScanSwrImageRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	namespaceImageInfoList:= "test"
	imageNameImageInfoList:= "openjdk"
	imageVersionImageInfoList:= "v8.8"
	namespaceImageInfoList1:= "test1"
	imageNameImageInfoList1:= "openjdk1"
	imageVersionImageInfoList1:= "v1.0"
	var listImageInfoListbody = []model.BatchScanSwrImageInfo{
        {
            Namespace: &namespaceImageInfoList,
            ImageName: &imageNameImageInfoList,
            ImageVersion: &imageVersionImageInfoList,
        },
        {
            Namespace: &namespaceImageInfoList1,
            ImageName: &imageNameImageInfoList1,
            ImageVersion: &imageVersionImageInfoList1,
        },
    }
	request.Body = &model.BatchScanPrivateImageRequestInfo{
		ImageType: "private_image",
		ImageInfoList: &listImageInfoListbody,
	}
	response, err := client.BatchScanSwrImage(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

类型为私有镜像的镜像进行全量扫描，body体没有传参镜像列表，operate_all=true，说明需要镜像列表全量扫描。

        
         
           
           
             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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

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

    request := &model.BatchScanSwrImageRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	operateAllBatchScanPrivateImageRequestInfo:= true
	request.Body = &model.BatchScanPrivateImageRequestInfo{
		ImageType: "private_image",
		OperateAll: &operateAllBatchScanPrivateImageRequestInfo,
	}
	response, err := client.BatchScanSwrImage(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

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

状态码

状态码	描述
200	successful response

错误码

请参见错误码。

父主题：容器镜像

上一篇：查询swr镜像仓库镜像列表

下一篇：本地镜像列表查询

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消