更新时间:2025-08-29 GMT+08:00
分享

获取镜像仓列表

功能介绍

获取镜像仓列表

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/image/registries

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

registry_name

String

参数解释:

仓库名称

取值范围:

字符长度1-128位

registry_id

String

参数解释:

仓库ID

取值范围:

字符长度1-64位

registry_type

String

参数解释:

镜像仓类型,不传默认返回所有类型。如果要查询多个类型,可以使用逗号分隔。

取值范围:

  • Harbor harbor

  • Jfrog jfrog

  • SwrPrivate swr私有

  • SwrShared swr共享

  • SwrEnterprise swr企业

  • Other 其他仓库

registry_addr

String

参数解释:

镜像仓地址

取值范围:

字符长度1-256位

status

String

参数解释

接入状态

约束限制

不涉及

取值范围

  • success:接入成功

  • fail:接入异常

  • accessing:接入中

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of RegistryInfo objects

参数解释:

镜像仓列表

取值范围:

列表项数量0-100

total_num

Integer

参数解释:

总数

取值范围:

0-100

表5 RegistryInfo

参数

参数类型

描述

id

String

参数解释:

镜像仓ID

取值范围:

字符长度1-64位

registry_name

String

参数解释:

仓库名称

取值范围:

字符长度1-128位

registry_type

String

参数解释:

镜像仓类型

取值范围:

  • Harbor harbor仓库

  • Jfrog jfrog仓库

  • SwrPrivate swr私有

  • SwrShared swr共享

  • SwrEnterprise swr企业

  • Other 其他仓库

api_version

String

参数解释

镜像仓接口版本

取值范围

  • V1:V1版本

  • V2:V2版本

protocol

String

参数解释

协议类型

取值范围

  • http:http协议

  • https:https协议

registry_addr

String

参数解释

镜像仓地址

取值范围

字符长度1-256位

registry_username

String

参数解释

用于登录镜像仓的用户名。

取值范围

字符长度1-128位

namespace

String

参数解释

镜像仓项目,用来指定扫描组件要上传到的镜像仓目录。get_scan_image_channel为Other时返回此值。

取值范围

字符长度1-128位

connect_cluster_id

String

参数解释

承载集群id

取值范围

字符长度1-64位

get_scan_image_channel

String

参数解释

获取扫描组件的方式

取值范围

  • Swr:访问swr获取扫描组件

  • Other:手动上传扫描组件到承载集群。

status

String

参数解释

接入状态

取值范围

  • success:接入成功

  • fail:接入异常

  • accessing:接入中

fail_reason

String

参数解释:

失败原因

取值范围:

  • CREATE_JOB_FAILED:集群接入状态异常,请检查集群接入状态。

  • REQUEST_API_ERROR:网络不通,访问镜像仓失败。请检查承载集群是否能正常访问镜像仓 ,或前往三方镜像仓页面重新接入。

  • SERVER_ERROR:系统内部错误,请稍后重试。

images_num

Integer

参数解释

镜像数量

取值范围

0-20000

latest_sync_time

Long

参数解释

最近同步时间,时间单位 毫秒(ms)

取值范围

0-9223372036854775807

请求示例

响应示例

状态码:200

请求已成功

{
  "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代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档