# 本地镜像扫描 - BatchScanLocalImage #### 功能介绍 本地镜像扫描。 #### 调用方法 请参见[如何调用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/local/batch-scan 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | 主机所属的企业项目ID。 开通企业项目功能后才需要配置企业项目。 企业项目ID默认取值为"0"，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参"all_granted_eps"。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） | | region | 是 | String | Region ID | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | operate_all | 否 | Boolean | 是否扫描全部本地镜像，true扫描所有，非true则不是 | | image_info_list | 否 | Array of [LocalImageInfo] objects | 需要扫描的本地镜像列表 | | image_name | 否 | String | 镜像名称 | | image_version | 否 | String | 镜像版本 | | local_image_type | 否 | String | 镜像类型，包含如下: - other_image : 其他镜像 - swr_image : swr镜像仓 | | scan_status | 否 | String | 扫描状态，包含如下: - unscan : 未扫描 - success : 扫描完成 - scanning : 扫描中 - failed : 扫描失败 - download_failed : 下载失败 - image_oversized : 镜像超大 | | 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） | 表5LocalImageInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | image_id | 否 | String | 镜像id | | image_digest | 否 | String | 镜像摘要 | | image_name | 否 | String | 镜像名称 | | image_version | 否 | String | 镜像版本 | #### 响应参数 **状态码：200** 请求已成功 无 #### 请求示例 本地镜像扫描 ``` POST https://{endpoint}/v5/{project_id}/image/local/batch-scan?enterprise_project_id=all_granted_eps { "image_info_list" : [ { "image_name" : "swr.cn-north-7.myhuaweicloud.com/scc_hss_container/install-hss-agent", "image_version" : "1.0.10.x86_64", "image_digest" : "sha256:05b5081012e562d14c374de2a4c74511f9e8e0adc572d3b35fb3df06de0da63b", "image_id" : "c499ab72-7ee9-4ee6-b6b7-5973230e7a7b" }, { "image_name" : "swr.cn-north-7.myhuaweicloud.com/glz/webshell-ljx", "image_version" : "v1", "image_digest" : "sha256:ce0b5d91b072730d0bc9518f11efd07eb7fdb9f43251e11a96cab5b1918b7044", "image_id" : "b8722a02-162f-4e4e-8100-127605e3a07b" } ], "operate_all" : false } ``` #### 响应示例 无 #### 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.*; import java.util.List; import java.util.ArrayList; public class BatchScanLocalImageSolution { 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(); BatchScanLocalImageRequest request = new BatchScanLocalImageRequest(); LocalImageBatchScanRequestBody body = new LocalImageBatchScanRequestBody(); List listbodyImageInfoList = new ArrayList<>(); listbodyImageInfoList.add( new LocalImageInfo() .withImageId("c499ab72-7ee9-4ee6-b6b7-5973230e7a7b") .withImageDigest("sha256:05b5081012e562d14c374de2a4c74511f9e8e0adc572d3b35fb3df06de0da63b") .withImageName("swr.cn-north-7.myhuaweicloud.com/scc_hss_container/install-hss-agent") .withImageVersion("1.0.10.x86_64") ); listbodyImageInfoList.add( new LocalImageInfo() .withImageId("b8722a02-162f-4e4e-8100-127605e3a07b") .withImageDigest("sha256:ce0b5d91b072730d0bc9518f11efd07eb7fdb9f43251e11a96cab5b1918b7044") .withImageName("swr.cn-north-7.myhuaweicloud.com/glz/webshell-ljx") .withImageVersion("v1") ); body.withImageInfoList(listbodyImageInfoList); body.withOperateAll(false); request.withBody(body); try { BatchScanLocalImageResponse response = client.batchScanLocalImage(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 = BatchScanLocalImageRequest() listImageInfoListbody = [ LocalImageInfo( image_id="c499ab72-7ee9-4ee6-b6b7-5973230e7a7b", image_digest="sha256:05b5081012e562d14c374de2a4c74511f9e8e0adc572d3b35fb3df06de0da63b", image_name="swr.cn-north-7.myhuaweicloud.com/scc_hss_container/install-hss-agent", image_version="1.0.10.x86_64" ), LocalImageInfo( image_id="b8722a02-162f-4e4e-8100-127605e3a07b", image_digest="sha256:ce0b5d91b072730d0bc9518f11efd07eb7fdb9f43251e11a96cab5b1918b7044", image_name="swr.cn-north-7.myhuaweicloud.com/glz/webshell-ljx", image_version="v1" ) ] request.body = LocalImageBatchScanRequestBody( image_info_list=listImageInfoListbody, operate_all=False ) response = client.batch_scan_local_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) ``` - [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.BatchScanLocalImageRequest{} imageIdImageInfoList:= "c499ab72-7ee9-4ee6-b6b7-5973230e7a7b" imageDigestImageInfoList:= "sha256:05b5081012e562d14c374de2a4c74511f9e8e0adc572d3b35fb3df06de0da63b" imageNameImageInfoList:= "swr.cn-north-7.myhuaweicloud.com/scc_hss_container/install-hss-agent" imageVersionImageInfoList:= "1.0.10.x86_64" imageIdImageInfoList1:= "b8722a02-162f-4e4e-8100-127605e3a07b" imageDigestImageInfoList1:= "sha256:ce0b5d91b072730d0bc9518f11efd07eb7fdb9f43251e11a96cab5b1918b7044" imageNameImageInfoList1:= "swr.cn-north-7.myhuaweicloud.com/glz/webshell-ljx" imageVersionImageInfoList1:= "v1" var listImageInfoListbody = []model.LocalImageInfo{ { ImageId: &imageIdImageInfoList, ImageDigest: &imageDigestImageInfoList, ImageName: &imageNameImageInfoList, ImageVersion: &imageVersionImageInfoList, }, { ImageId: &imageIdImageInfoList1, ImageDigest: &imageDigestImageInfoList1, ImageName: &imageNameImageInfoList1, ImageVersion: &imageVersionImageInfoList1, }, } operateAllLocalImageBatchScanRequestBody:= false request.Body = &model.LocalImageBatchScanRequestBody{ ImageInfoList: &listImageInfoListbody, OperateAll: &operateAllLocalImageBatchScanRequestBody, } response, err := client.BatchScanLocalImage(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=BatchScanLocalImage&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。