Updated on 2025-09-08 GMT+08:00

Obtaining the Image Repository List

Function

This API is used to obtain the image repository list.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/image/registries

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.

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.

limit

No

Integer

Parameter description:

Number of records displayed on each page.

Constraints:

N/A

Options:

Value range: 10-200

Default value:

10

registry_name

No

String

Definition

Repository name.

Range

The value can contain 1 to 128 characters.

registry_id

No

String

Definition

Registry ID.

Range

Length: 1 to 64 characters

registry_type

No

String

Definition

Image repository type. If this parameter is not specified, all types are returned by default. To query multiple types, separate them with commas (,).

Range

  • Harbor harbor

  • Jfrog jfrog

  • SwrPrivate: SWR private repository

  • SwrShared: SWR shared repository

  • SwrEnterprise: SWR enterprise repository

  • Other: other repository

registry_addr

No

String

Definition

Image Repository Address

Range

Length: 1 to 256 characters

status

No

String

Definition

Access Status

Constraints

N/A

Range

  • success: The access is successful.

  • fail: The access is abnormal.

  • accessing: accessing

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

data_list

Array of RegistryInfo objects

Definition

Image repository list

Range

Number of items in the list. The value ranges from 0 to 100.

total_num

Integer

Definition

Total number.

Range

0-100

Table 5 RegistryInfo

Parameter

Type

Description

id

String

Definition

Image repository ID.

Range

Length: 1 to 64 characters

registry_name

String

Definition

Registry name.

Range

Length: 1 to 128 characters

registry_type

String

Definition

Image repository type.

Range

  • Harbor: Harbor repository

  • Jfrog: JFrog repository

  • SwrPrivate: SWR private repository

  • SwrShared: SWR shared repository

  • SwrEnterprise: SWR enterprise repository

  • Other: other repository

api_version

String

Definition

Image repository API version.

Range

  • V1: V1 version

  • V2: V2 version

protocol

String

Definition

Protocol type.

Range

  • http: HTTP protocol

  • https: HTTPS protocol

registry_addr

String

Definition

Image Repository Address

Range

Length: 1 to 256 characters

registry_username

String

Definition

Username for logging in to the image repository.

Range

Length: 1 to 128 characters

namespace

String

Definition

Image repository project, which is used to specify the image repository directory that the scan component is to be uploaded to. This value is returned when get_scan_image_channel is set to Other.

Range

Length: 1 to 128 characters

connect_cluster_id

String

Definition

Jumper cluster ID.

Range

Length: 1 to 64 characters

get_scan_image_channel

String

Definition

Method of obtaining the scan component.

Range

  • Swr: Access SWR to obtain the scan component.

  • Other: Manually upload the scan component to the jumper cluster.

status

String

Definition

Access Status

Range

  • success: The access is successful.

  • fail: The access is abnormal.

  • accessing: accessing

fail_reason

String

Definition

reason

Range

  • CREATE_JOB_FAILED: The cluster access status is abnormal. Check the cluster access status.

  • REQUEST_API_ERROR: The network is disconnected, and the image repository fails to be accessed. Check whether the container cluster can access the image repository or retry on the Third-party Image Repository page.

  • SERVER_ERROR: Internal system error. Try again later.

images_num

Integer

Definition

Number of images.

Range

0-20000

latest_sync_time

Long

Definition

Last synchronization time, in ms.

Range

0-9223372036854775807

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 4,
  "data_list" : [ {
    "id" : "ad7552e3-1eb7-475a-b5a4-3d28262b855e",
    "registry_name" : "0109test",
    "registry_type" : "Jfrog",
    "api_version" : "V1",
    "protocol" : "http",
    "registry_addr" : "100.85.219.197:8082",
    "registry_username" : "admin",
    "connect_cluster_id" : "db69f3e6-887f-11ef-9825-0255ac1001b6",
    "get_scan_image_channel" : "Swr",
    "status" : "fail",
    "fail_reason" : "REQUEST_API_ERROR",
    "images_num" : 0,
    "latest_sync_time" : 1736925890944
  } ]
}

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

    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();
        ListRegistryRequest request = new ListRegistryRequest();
        try {
            ListRegistryResponse response = client.listRegistry(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
# 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 = ListRegistryRequest()
        response = client.list_registry(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
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.ListRegistryRequest{}
	response, err := client.ListRegistry(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.