Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Host Security Service/ API Reference/ API Description/ Container Image/ Scanning Images in the Image Repository in Batches

Scanning Images in the Image Repository in Batches

Function

This API is used to scan images in the image repository in batches.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project that a server belongs.

An enterprise project can be configured only after the enterprise project function is enabled.

Enterprise project ID. The value 0 indicates the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you have only the permission on an enterprise project, you need to transfer the enterprise project ID to query the server in the enterprise project. Otherwise, an error is reported due to insufficient permission.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

region

No

String

Region ID

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

repo_type

No

String

Repository type. Currently, SWR image repositories are connected. The options are as follows:

  • SWR: SWR image repository

image_info_list

No

Array of BatchScanSwrImageInfo objects

Specifies the list of images to be scanned. This parameter is mandatory when operate_all is false.

operate_all

No

Boolean

If this parameter is set to true, all filter criteria can be used for full query. If image_info_list is empty, this parameter is mandatory.

namespace

No

String

Organization name

image_name

No

String

Image name

image_version

No

String

Image tag

image_type

Yes

String

Image type. The options are as follows:

  • private_image: private image repository

  • shared_image: shared image repository

scan_status

No

String

Scan status. The options are as follows:

  • unscan

  • success

  • scanning

  • failed

  • download_failed

  • image_oversized

latest_version

No

Boolean

Display latest image versions only

image_size

No

Long

Image size

start_latest_update_time

No

Long

Creation start date, in ms.

end_latest_update_time

No

Long

Creation end date, in ms.

start_latest_scan_time

No

Long

The start time of latest scan completion, in ms.

end_latest_scan_time

No

Long

The end time of latest scan completion, in ms.

Table 5 BatchScanSwrImageInfo

Parameter

Mandatory

Type

Description

namespace

No

String

Namespace

image_name

No

String

Image name

image_version

No

String

Image tag

instance_id

No

String

Enterprise instance ID

instance_url

No

String

Downloading the enterprise image URL

Response Parameters

None

Example Requests

  • Scan private images in batches. The request body transfers the image list and operate_all does not contain any parameter, indicating that the image list needs to be scanned in batches.

    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"
      } ]
    }
  • Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.

    POST https://{endpoint}/v5/{project_id}/image/batch-scan
    
    {
      "image_type" : "private_image",
      "operate_all" : true
    }

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

  • Scan private images in batches. The request body transfers the image list and operate_all does not contain any parameter, indicating that the image list needs to be scanned in batches.

     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
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    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");
            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();
            BatchScanSwrImageRequest request = new BatchScanSwrImageRequest();
            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());
            }
        }
    }
    
  • Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.

     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
    50
    51
    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");
            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();
            BatchScanSwrImageRequest request = new BatchScanSwrImageRequest();
            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());
            }
        }
    }
    
  • Scan private images in batches. The request body transfers the image list and operate_all does not contain any parameter, indicating that the image list needs to be scanned in batches.

     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
    # 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 = BatchScanSwrImageRequest()
            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)
    
  • Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.

     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
    # 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 = BatchScanSwrImageRequest()
            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)
    
  • Scan private images in batches. The request body transfers the image list and operate_all does not contain any parameter, indicating that the image list needs to be scanned in batches.

     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
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    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.BatchScanSwrImageRequest{}
    	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)
        }
    }
    
  • Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.

     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
    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.BatchScanSwrImageRequest{}
    	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)
        }
    }
    

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

  • Scan private images in batches. The request body transfers the image list and operate_all does not contain any parameter, indicating that the image list needs to be scanned in batches.

     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
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    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");
            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();
            BatchScanSwrImageRequest request = new BatchScanSwrImageRequest();
            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());
            }
        }
    }
    
  • Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.

     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
    50
    51
    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");
            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();
            BatchScanSwrImageRequest request = new BatchScanSwrImageRequest();
            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());
            }
        }
    }
    
  • Scan private images in batches. The request body transfers the image list and operate_all does not contain any parameter, indicating that the image list needs to be scanned in batches.

     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
    # 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 = BatchScanSwrImageRequest()
            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)
    
  • Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.

     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
    # 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 = BatchScanSwrImageRequest()
            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)
    
  • Scan private images in batches. The request body transfers the image list and operate_all does not contain any parameter, indicating that the image list needs to be scanned in batches.

     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
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    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.BatchScanSwrImageRequest{}
    	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)
        }
    }
    
  • Perform a full scan for private images. The request body does not transfer the image list and operate_all is set to true, indicating that the image list needs to be fully scanned.

     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
    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.BatchScanSwrImageRequest{}
    	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)
        }
    }
    

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback