Querying the Image List of a Repository

Function

This API is used to query the image list of a repository.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/image/registries/images

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
namespace	No	String	Definition Organization name. Constraints N/A Range Length: 1 to 128 characters Default Value N/A
image_name	No	String	Definition Image name. Range Length: 1 to 128 characters
image_version	No	String	Definition Image tag. Range Length: 1 to 64 characters
registry_name	No	String	Definition Repository name. Range The value can contain 1 to 128 characters.
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
image_type	No	String	Definition Image type. Constraints N/A Range private_image: SWR private image shared_image: SWR shared image instance_image: SWR enterprise edition image harbor: Harbor repository image jfrog: JFrog image Default Value N/A
sort_key	No	String	Definition Sorting field. Constraints N/A Range latest_scan_time: latest scan time Default Value N/A
sort_dir	No	String	Definition Sorting order. Constraints N/A Range asc: ascending desc: descending Default Value Sort in ascending order.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range 1 to 200 Default Value 10
latest_version	No	Boolean	Display latest image versions only
image_size	No	Long	Definition Image size Constraints N/A Range 0 to 2,147,483,547 Default Value N/A
scan_status	No	String	Definition Scan status Constraints N/A Range unscan: not scanned success: The scan is complete. scanning: scanning failed: The scan failed. waiting_for_scan: waiting for scan Default Value N/A
start_latest_update_time	No	Long	Definition Creation start date, in ms. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A
end_latest_update_time	No	Long	Definition Creation end date, in ms. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A
start_latest_scan_time	No	Long	Definition The start time of latest scan completion, in ms. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A
end_latest_scan_time	No	Long	Definition End date of the latest scan completion time, in ms. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A
start_latest_sync_time	No	Long	Definition Start time of the latest synchronization completion, in ms. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A
end_latest_sync_time	No	Long	Definition End time of the latest synchronization completion, in ms. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A
has_malicious_file	No	Boolean	Whether there are malicious files
has_unsafe_setting	No	Boolean	Whether there are baseline check risks.
has_vul	No	Boolean	Whether there are software vulnerabilities
risky	No	Boolean	There are security risks.
instance_id	No	String	Definition Enterprise repository instance ID. This parameter can be specified for the enterprise edition SWR. Constraints N/A Range Length: 0 to 128 characters Default Value N/A
instance_name	No	String	Definition Enterprise image instance name. This parameter can be specified for the enterprise edition SWR. Constraints N/A Range Length: 0 to 128 characters Default Value N/A
is_multarch	No	Boolean	Whether it is a multi-architecture image.
severity_level	No	String	Definition Image risk level, which is displayed after the image scan is complete. Constraints N/A Range Security: secure Low: low-risk Medium: medium-risk High: high-risk Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range 0-2147483547
data_list	Array of RegistryImagesInfo objects	Repository image list

**Table 5** RegistryImagesInfo
Parameter	Type	Description
id	Long	Definition id Range Minimum value: 0; maximum value: 9223372036854775807
namespace	String	Definition Organization name. Range Length: 0 to 64 characters
image_name	String	Definition Image name. Range Length: 0 to 128 characters
image_id	String	Definition Image ID. Range Length: 0 to 64 characters
image_digest	String	Definition Image digest. Range Length: 0 to 128 characters
image_version	String	Definition Image tag. Range Length: 0 to 64 characters
image_type	String	Definition Image type. Range private_image: SWR private image shared_image: SWR shared image instance_image: SWR enterprise edition image harbor: Harbor repository image jfrog: JFrog image
registry_id	String	Definition Image repository ID Range Length: 1 to 64 characters
registry_name	String	Definition Image repository name. Range Length: 1 to 128 characters
registry_type	String	Definition Image repository type. Range SwrPrivate: SWR private repository SwrShared: SWR shared repository SwrEnterprise: SWR enterprise repository Harbor: Harbor repository Jfrog: JFrog repository Other: other repository
latest_version	Boolean	Latest Version
scan_status	String	Definition Scan status Range unscan: not scanned success: The scan is complete. scanning: The scan is in progress. failed: The scan failed. download_failed: The download failed. image_oversized: The image is too large. waiting_for_scan: waiting for scan
scan_failed_desc	String	Definition Failure cause of the scan. Range The scan failure cause codes and their description are as follows: unknown_error: Unknown error. authentication_failed: Authentication failed. download_failed: The image download failed. Contact technical support. image_over_sized: The image is too large and cannot be scanned. Reduce the image size. get_detail_info_not_found: Image details failed to be obtained. The image is not found in the repository. Synchronize the latest images. image_layer_over_sized: The image has too many layers and cannot be scanned. Reduce the image size. schema_v1_not_support: Schema V1 images cannot be scanned. Upgrade to V2. access_swr_failed: Failed to access SWR. Contact technical support. swr_authentication_error: The SWR authorization is missing. Refer to the image authorization guide to configure permissions. failed_to_scan_vulnerability: The vulnerability scan failed. failed_to_scan_file: The file scan failed. failed_to_scan_software: The software scan failed. failed_to_check_sensitive_information: Failed to check sensitive information. failed_to_check_baseline: Baseline check failed. failed_to_check_software_compliance: The software compliance check failed. failed_to_query_basic_image_information: Failed to query the basic image information. failed_to_check_build_cmd: Failed to scan the image building instructions. response_timed_out: The response timed out. database_error: Database error. failed_to_send_the_scan_request: Failed to send the scan request.
scan_failed_code	String	Definition Failure cause code of the scan. Range The scan failure cause codes and their description are as follows: unknown_error: Unknown error. authentication_failed: Authentication failed. download_failed: The image download failed. Contact technical support. image_over_sized: The image is too large and cannot be scanned. Reduce the image size. get_detail_info_not_found: Image details failed to be obtained. The image is not found in the repository. Synchronize the latest images. image_layer_over_sized: The image has too many layers and cannot be scanned. Reduce the image size. schema_v1_not_support: Schema V1 images cannot be scanned. Upgrade to V2. access_swr_failed: Failed to access SWR. Contact technical support. swr_authentication_error: The SWR authorization is missing. Refer to the image authorization guide to configure permissions. failed_to_scan_vulnerability: The vulnerability scan failed. failed_to_scan_file: The file scan failed. failed_to_scan_software: The software scan failed. failed_to_check_sensitive_information: Failed to check sensitive information. failed_to_check_baseline: Baseline check failed. failed_to_check_software_compliance: The software compliance check failed. failed_to_query_basic_image_information: Failed to query the basic image information. failed_to_check_build_cmd: Failed to scan the image building instructions. response_timed_out: The response timed out. database_error: Database error. failed_to_send_the_scan_request: Failed to send the scan request.
image_size	Long	Definition Image size Range 0 to 2,147,483,547
latest_update_time	Long	Definition Last update time of the image tag, in ms. Range The value range is 0 to 9,223,372,036,854,775,807.
latest_scan_time	Long	Definition Last scanned, in ms. Range The value range is 0 to 9,223,372,036,854,775,807.
latest_sync_time	Long	Definition Last synchronization time, in ms. Range The value range is 0 to 9,223,372,036,854,775,807.
vul_num	Integer	Definition Number of vulnerabilities Range The value range is 0 to 2,147,483,647.
unsafe_setting_num	Integer	Definition Number of settings that failed the baseline check Range The value range is 0 to 2,147,483,647.
malicious_file_num	Integer	Definition Number of malicious files Range The value range is 0 to 2,147,483,647.
domain_name	String	Definition Owner (shared image parameter) Range Length: 0 to 128
shared_status	String	Definition Shared image status. Range expired: expired effective: valid
scannable	Boolean	Scan or Not
is_multiple_arch	Boolean	Whether it is a multi-architecture image.
instance_name	String	Definition Enterprise image instance name Range Length: 0 to 128
instance_id	String	Definition Enterprise image instance ID Range Length: 0 to 64
instance_url	String	Definition Enterprise image instance URL Range Length: 0 to 256
severity_level	String	Definition Image risk level, which is displayed after the image scan is complete. Range Security: secure Low: low-risk Medium: medium-risk High: high-risk
association_images	Array of AssociateImagesInfo objects	Multi-architecture associated image information

**Table 6** AssociateImagesInfo
Parameter	Type	Description
id	Long	Definition id Range Minimum value: 0; maximum value: 9223372036854775807
image_id	String	Definition Image ID. Range Length: 0 to 64 characters
image_name	String	Definition Image name. Range Length: 0 to 128 characters
image_version	String	Definition Image tag. Range Length: 0 to 64 characters
image_type	String	Definition Image type. Range private_image: SWR private image shared_image: SWR shared image instance_image: SWR enterprise edition image harbor: Harbor repository image jfrog: JFrog image
namespace	String	Definition Organization name. Range Length: 0 to 64 characters
image_digest	String	Definition Image digest. Range Length: 0 to 128 characters
scan_status	String	Definition Scan status Range unscan: not scanned success: The scan is complete. scanning: The scan is in progress. failed: The scan failed. download_failed: The download failed. image_oversized: The image is too large. waiting_for_scan: waiting for scan
vul_num	Integer	Definition Number of vulnerabilities Range The value range is 0 to 2,147,483,647.
unsafe_setting_num	Integer	Definition Number of settings that failed the baseline check Range The value range is 0 to 2,147,483,647.
malicious_file_num	Integer	Definition Number of malicious files Range The value range is 0 to 2,147,483,647.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 3,
  "data_list" : [ {
    "id" : "111 (example for private images)",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "centos7",
    "image_size" : "1,000 (bytes)",
    "image_type" : "private_image",
    "image_version" : "common",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "",
    "instance_id" : "",
    "instance_url" : ""
  }, {
    "id" : "222 (example for shared images)",
    "domain_name" : "scc_cgs_XXX",
    "shared_status" : "effective",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "mysql",
    "image_size" : "1,000 (bytes)",
    "image_type" : "shared_image",
    "image_version" : "5.5",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "failed",
    "scan_failed_desc" : "Authentication failed.",
    "scan_failed_code" : "authentication_failed",
    "scannable" : true,
    "unsafe_setting_num" : 0,
    "vul_num" : 0,
    "instance_name" : "",
    "instance_id" : "",
    "instance_url" : ""
  }, {
    "id" : "333 (example for enterprise images)",
    "domain_name" : "scc_cgs_XXX",
    "shared_status" : "effective",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "mysql",
    "image_size" : "1,000 (bytes)",
    "image_type" : "shared_image",
    "image_version" : "5.5",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "Enterprise instance name",
    "instance_id" : "",
    "instance_url" : ""
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

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

    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();
        ListRegistryImagesRequest request = new ListRegistryImagesRequest();
        try {
            ListRegistryImagesResponse response = client.listRegistryImages(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = ListRegistryImagesRequest()
        response = client.list_registry_images(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           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.ListRegistryImagesRequest{}
	response, err := client.ListRegistryImages(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     