Help Center> Host Security Service (New)> API Reference> API Description> Container Image> Querying the Image List in the SWR Image Repository
Updated on 2024-05-13 GMT+08:00

Querying the Image List in the SWR Image Repository

Function

This API is used to query the image list in the SWR image repository. To synchronize the latest images from SWR, call the API for synchronizing images from SWR first.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/image/swr-repository

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant project ID

Minimum: 1

Maximum: 256

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.

Default: 0

Minimum: 1

Maximum: 256

namespace

No

String

Organization name

Minimum: 1

Maximum: 256

image_name

No

String

Image name ID

Minimum: 1

Maximum: 128

image_version

No

String

Image tag

Minimum: 1

Maximum: 64

latest_version

No

Boolean

Display latest image versions only

Default: false

offset

No

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

Minimum: 0

Maximum: 2000000

Default: 0

limit

No

Integer

Number of records displayed on each page.

Minimum: 10

Maximum: 200

Default: 10

image_type

Yes

String

Image type. The options are as follows:

  • private_image: private image repository

  • shared_image: shared image repository

  • local_image

  • instance_image: enterprise image

Minimum: 1

Maximum: 32

scan_status

No

String

Scanning status. The options are as follows:

  • unscan

  • success

  • scanning

  • failed

  • waiting_for_scan

Minimum: 0

Maximum: 32

instance_name

No

String

Enterprise image instance name

Minimum: 0

Maximum: 128

image_size

No

Long

Image size

Minimum: 0

Maximum: 2147483547

Default: 0

start_latest_update_time

No

Long

Creation start time(ms).

Minimum: 0

Maximum: 4070880000000

Default: 0

end_latest_update_time

No

Long

Creation end time(ms).

Minimum: 0

Maximum: 4070880000000

Default: 0

start_latest_scan_time

No

Long

The start time of latest scan completion, in ms.

Minimum: 0

Maximum: 4070880000000

Default: 0

end_latest_scan_time

No

Long

The end time of latest scan completion, in ms.

Minimum: 0

Maximum: 4070880000000

Default: 0

has_malicious_file

No

Boolean

Whether there are malicious files

has_unsafe_setting

No

Boolean

Whether baseline check exists

has_vul

No

Boolean

Whether there are software vulnerabilities

instance_id

No

String

Enterprise repository instance ID. This API is not required for SWR shared edition.

Minimum: 0

Maximum: 128

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.

Minimum: 1

Maximum: 32768

region

Yes

String

Region ID

Minimum: 0

Maximum: 128

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number

Minimum: 0

Maximum: 2147483547

data_list

Array of PrivateImageRepositoryInfo objects

Querying the image list in the SWR image repository

Array Length: 0 - 200

Table 5 PrivateImageRepositoryInfo

Parameter

Type

Description

id

Long

id

Minimum: 0

Maximum: 2147483547

namespace

String

Namespace

Minimum: 0

Maximum: 64

image_name

String

Image name

Minimum: 0

Maximum: 128

image_id

String

Image ID

Minimum: 0

Maximum: 64

image_digest

String

Image digest

Minimum: 0

Maximum: 128

image_version

String

Image tag

Minimum: 0

Maximum: 64

image_type

String

Image type. The options are as follows:

  • private_image

  • shared_image

Minimum: 0

Maximum: 64

latest_version

Boolean

Check whether the version is the latest.

scan_status

String

Scan status. The options are as follows:

  • unscan

  • success

  • scanning

  • failed

  • download_failed

  • image_oversized

  • waiting_for_scan

Minimum: 0

Maximum: 64

scan_failed_desc

String

Cause of the scanning failure. The options are as follows:

  • "unknown_error"

  • "authentication_failed"

  • "download_failed": Failed to download the image.

  • "image_over_sized": The size of the image exceeds the maximum.

  • "image_oversized"

  • "failed_to_scan_vulnerability"

  • "failed_to_scan_file"

  • "failed_to_scan_software"

  • "failed_to_check_sensitive_information"

  • "failed_to_check_baseline"

  • "failed_to_check_software_compliance"

  • "failed_to_query_basic_image_information"

  • "response_timed_out"

  • "database_error"

  • "failed_to_send_the_scan_request"

Minimum: 0

Maximum: 64

image_size

Long

Image size

Minimum: 0

Maximum: 2147483547

latest_update_time

Long

Last update time of the image version, in ms.

Minimum: 0

Maximum: 4070880000000

latest_scan_time

Long

Last scanned, in ms.

Minimum: 0

Maximum: 4070880000000

vul_num

Integer

Vulnerabilities

Minimum: 0

Maximum: 2147483647

unsafe_setting_num

Integer

Number of failed baseline scans

Minimum: 0

Maximum: 2147483647

malicious_file_num

Integer

Number of malicious files

Minimum: 0

Maximum: 2147483647

domain_name

String

Owner (shared image parameter)

Minimum: 0

Maximum: 128

shared_status

String

The status of a shared image. The value can be:

  • expired

  • effective

Minimum: 1

Maximum: 32

scannable

Boolean

Scannable or not

instance_name

String

Instance name of enterprise edition image

Minimum: 0

Maximum: 128

instance_id

String

Instance ID of enterprise edition image

Minimum: 0

Maximum: 64

instance_url

String

Instance URL of enterprise edition image

Minimum: 0

Maximum: 256

association_images

Array of AssociateImages objects

Multi-architecture associated image information

Array Length: 0 - 200

Table 6 AssociateImages

Parameter

Type

Description

image_name

String

Image name

Minimum: 0

Maximum: 128

image_version

String

Image tag

Minimum: 0

Maximum: 64

image_type

String

Image type

Minimum: 0

Maximum: 64

namespace

String

Namespace

Minimum: 0

Maximum: 64

image_digest

String

Image digest

Minimum: 0

Maximum: 128

scan_status

String

Scan status. The options are as follows:

  • unscan

  • success

  • scanning

  • failed

  • download_failed

  • image_oversized

  • waiting_for_scan

Minimum: 0

Maximum: 32

Example Requests

Query the image list in the SWR image repository whose image type is private image.

GET https://{endpoint}/v5/{project_id}/image/swr-repository?offset=0&limit=50&image_type=private_image&latest_version=false&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

This API is used to query the image list in the SWR image repository, including the private image list and shared image list (controlled by the input parameter image_type).

{
  "total_num" : 3,
  "data_list" : [ {
    "id" : "111 (example for private images)",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "centos7",
    "image_size" : "1000 (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 image)",
    "domain_name" : "scc_cgs_XXX",
    "shared_status" : "effective",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "mysql",
    "image_size" : "1000 (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" : "",
    "instance_id" : "",
    "instance_url" : ""
  }, {
    "id" : "333 (example of an enterprise image)",
    "domain_name" : "scc_cgs_XXX",
    "shared_status" : "effective",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "mysql",
    "image_size" : "1000 (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.

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

    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();
        ListSwrImageRepositoryRequest request = new ListSwrImageRepositoryRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withNamespace("<namespace>");
        request.withImageName("<image_name>");
        request.withImageVersion("<image_version>");
        request.withLatestVersion(<latest_version>);
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withImageType("<image_type>");
        request.withScanStatus("<scan_status>");
        request.withInstanceName("<instance_name>");
        request.withImageSize(<image_size>L);
        request.withStartLatestUpdateTime(<start_latest_update_time>L);
        request.withEndLatestUpdateTime(<end_latest_update_time>L);
        request.withStartLatestScanTime(<start_latest_scan_time>L);
        request.withEndLatestScanTime(<end_latest_scan_time>L);
        request.withHasMaliciousFile(<has_malicious_file>);
        request.withHasUnsafeSetting(<has_unsafe_setting>);
        request.withHasVul(<has_vul>);
        request.withInstanceId("<instance_id>");
        try {
            ListSwrImageRepositoryResponse response = client.listSwrImageRepository(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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListSwrImageRepositoryRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.namespace = "<namespace>"
        request.image_name = "<image_name>"
        request.image_version = "<image_version>"
        request.latest_version = <LatestVersion>
        request.offset = <offset>
        request.limit = <limit>
        request.image_type = "<image_type>"
        request.scan_status = "<scan_status>"
        request.instance_name = "<instance_name>"
        request.image_size = <image_size>
        request.start_latest_update_time = <start_latest_update_time>
        request.end_latest_update_time = <end_latest_update_time>
        request.start_latest_scan_time = <start_latest_scan_time>
        request.end_latest_scan_time = <end_latest_scan_time>
        request.has_malicious_file = <HasMaliciousFile>
        request.has_unsafe_setting = <HasUnsafeSetting>
        request.has_vul = <HasVul>
        request.instance_id = "<instance_id>"
        response = client.list_swr_image_repository(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
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
67
68
69
70
71
72
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.ListSwrImageRepositoryRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	namespaceRequest:= "<namespace>"
	request.Namespace = &namespaceRequest
	imageNameRequest:= "<image_name>"
	request.ImageName = &imageNameRequest
	imageVersionRequest:= "<image_version>"
	request.ImageVersion = &imageVersionRequest
	latestVersionRequest:= <latest_version>
	request.LatestVersion = &latestVersionRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	request.ImageType = "<image_type>"
	scanStatusRequest:= "<scan_status>"
	request.ScanStatus = &scanStatusRequest
	instanceNameRequest:= "<instance_name>"
	request.InstanceName = &instanceNameRequest
	imageSizeRequest:= int64(<image_size>)
	request.ImageSize = &imageSizeRequest
	startLatestUpdateTimeRequest:= int64(<start_latest_update_time>)
	request.StartLatestUpdateTime = &startLatestUpdateTimeRequest
	endLatestUpdateTimeRequest:= int64(<end_latest_update_time>)
	request.EndLatestUpdateTime = &endLatestUpdateTimeRequest
	startLatestScanTimeRequest:= int64(<start_latest_scan_time>)
	request.StartLatestScanTime = &startLatestScanTimeRequest
	endLatestScanTimeRequest:= int64(<end_latest_scan_time>)
	request.EndLatestScanTime = &endLatestScanTimeRequest
	hasMaliciousFileRequest:= <has_malicious_file>
	request.HasMaliciousFile = &hasMaliciousFileRequest
	hasUnsafeSettingRequest:= <has_unsafe_setting>
	request.HasUnsafeSetting = &hasUnsafeSettingRequest
	hasVulRequest:= <has_vul>
	request.HasVul = &hasVulRequest
	instanceIdRequest:= "<instance_id>"
	request.InstanceId = &instanceIdRequest
	response, err := client.ListSwrImageRepository(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

This API is used to query the image list in the SWR image repository, including the private image list and shared image list (controlled by the input parameter image_type).

Error Codes

See Error Codes.