You need to enable JavaScript to run this app.
导航
ListRegistries
最近更新时间:2024.11.28 11:20:00首次发布时间:2022.06.14 21:29:03

查询一个或多个镜像仓库实例。

接口说明

查询镜像仓库实例时,通过 Filter 参数,控制镜像仓库实例的筛选条件。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=ListRegistries&Version=2022-05-12

调试

请求参数

调用该 API 时,除了以下请求参数外,还需传入公共请求参数。公共请求参数说明,请参见 火山引擎公共参数文档

参数类型是否必选示例值描述
ActionStringListRegistries接口名称。当前 API 的名称为 ListRegistries
VersionString2022-05-12接口版本。当前 API 的版本为 2022-05-12
FilterObject of RegistryFilter待查询镜像仓库实例的过滤条件。
ResourceTagFiltersArray of ResourceTagFilter查询镜像仓库实例标签的过滤条件。
PageSizeLong10单页展示的镜像仓库实例数量,默认为 10 个,取值范围为 [1,100] 的整数。
PageNumberLong1开始显示返回结果的页码,从 1 开始,默认为 1,取值范围为 [1,2147483647] 的整数。

RegistryFilter

参数类型是否必选示例值描述

Names

Array of String

["registrya", "registryb"]

指定镜像仓库实例或远端代理仓名称。在 镜像仓库控制台 的 实例列表 或 远端代理 页面,获取实例或远端代理仓的名称。
支持精确匹配和模糊匹配,模糊匹配仅支持使用星号(*)作为通配符。单次最多填写 20 个实例或远端代理仓名称。

Types

Array of String

["Micro","Enterprise"]

镜像仓库实例类型。取值如下:

  • Basic:基础版实例。
  • Trial:体验版实例。
  • Enterprise:标准版实例。
  • Micro:小微版实例。
    可填写一个或多个实例类型。
ProjectsArray of String["default","projecta"]关联的项目名称。
StatusesArray of StatusFilter镜像仓库实例的状态,单次调用最多可填写 10 个 StatusFilter 组合。

ResourceTagFilter

参数类型是否必选示例值描述
KeyStringkey1标签的 Key 值。
ValuesArray of String["value1","value2"]标签的 Value 值。

StatusFilter

参数类型是否必选示例值描述

Phase

String

Running

实例状态(Status)由 Phase 和 Conditions 组成。

  • Creating, [ Progressing ] :创建中。
  • Running, [ Ok ] :运行中。
  • Running, [ Degraded ] :运行中。
  • Stopped, [ Balance ] : 欠费关停。
  • Stopped, [ Released ] :待回收。
  • Stopped, [ ReleasedBalance ] :欠费关停。
  • Starting, [ Progressing ] :启动中。
  • Deleting, [ Progressing ] :销毁中。
  • Failed, [ Unknown ] :异常。

Condition

String

Ok

实例状态(Status)由 Phase 和 Conditions 组成。
Creating, [ Progressing ] :创建中。
Running, [ Ok ] :运行中。
Running, [ Degraded ] :运行中。
Stopped, [ Balance ] : 欠费关停。
Stopped, [ Released ] :待回收。
Stopped, [ Released, Balance ] :欠费关停。
Starting, [ Progressing ] :启动中。
Deleting, [ Progressing ] :销毁中。
Failed, [ Unknown ] :异常。

请求示例

POST https://open.volcengineapi.com?Action=ListRegistries&Version=2022-05-12
{
    "Filter": {
        "Names": ["example"]
    }
}

返回参数

参数类型示例值描述
TotalCountLong1查询到的镜像仓库实例数量。
PageNumberLong1当前页码。
PageSizeLong10单页显示的镜像仓库实例信息条数。
ItemsArray of Registry镜像仓库实例列表。

Registry

参数类型示例值描述
NameStringtest-registry镜像仓库实例名称。

Type

String

Basic

镜像仓库实例类型,参数值说明如下:

  • Basic:基础版实例。仅部分历史版本用户支持使用,不支持在控制台查看。
  • Trial:体验版实例。
  • Enterprise:标准版实例。
  • Micro:小微版实例。
ChargeTypeStringPostCharge镜像仓库实例的付费类型,目前仅支持 PostCharge 按量付费模式。

Status

Object of RegistryStatus

{
"Phase": "Running",
"Conditions": ["Ok"]
}

镜像仓库实例状态,由 Phase 和 Conditions 组成。
合法的 Phase 和 Conditions 组合如下所示:

  • {Creating, [Progressing]}:创建中
  • {Running, [Ok]}:运行中
  • {Running, [Degraded]}:运行中
  • {Stopped, [Balance]}:欠费关停
  • {Stopped, [Released]}:待回收
  • {Stopped, [Released, Balance]}:欠费关停
  • {Starting, [Progressing]}:启动中
  • {Deleting, [Progressing]}:销毁中
  • {Failed, [Unknown]}:异常
ProjectStringprojecta填写实例需要关联的项目。一个实例仅支持关联一个项目。
ResourceTagsArray of ResourceTag支持通过键值对,自定义实例的标签。支持在 分账账单 中基于实例标签查看账单信息,详情说明参见 分账账单
CreateTimeString2022-05-20T13:00:55Z创建镜像仓库实例的时间。RFC3339 格式的 UTC+0 时间。
ExpireTimeString2022-05-20T13:00:55Z实例或远端代理仓到期时间。仅计费类型为 HybridCharge 混合计费时存在返回值。
RenewTypeStringManual实例或远端代理仓到期时间。仅计费类型为 HybridCharge 混合计费时存在返回值。

ProxyCache

Object of ProxyCache

{
"Type": "Dockerhub"
}

远端代理仓配置说明。

ProxyCacheEnabledBooleantrue是否为远端代理仓。

RegistryStatus

参数类型示例值描述

Phase

String

Running

镜像仓库实例状态,参数值如下:

  • Creating
  • Running
  • Stopped
  • Starting
  • Deleting
  • Failed

Conditions

Array of String

["ok"]

镜像仓库实例进入当前状态下的条件、即进入该状态的原因等,可以有多个原因。参数值如下:

  • Ok
  • Progressing
  • Degraded
  • Balance
  • Released
  • Unknown

ResourceTag

参数类型示例值描述
KeyStringkey1标签的 Key 值。
ValueStringval1标签的 Value 值列表。

ProxyCache

参数类型示例值描述

Type

String

DockerHub

远端代理仓支持的类型。

  • DockerHub:Docker Hub 类型的远端代理仓,支持在大陆地区拉取 Docker Hub 中镜像。
  • DockerRegistry:通用类型的远端代理仓,可以支持多云场景中主备仓需求。

返回示例

{
    "ResponseMetadata" : {
        "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
        "Action": "ListRegistries",
        "Version": "2022-05-12",
        "Service": "cr",
        "Region": "cn-beijing",
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "Items": [
            {
                "Name": "example",
                "Type": "Enterprise",
                "Status": {
                    "Phase": "Running",
                    "Conditions": ["ok"]
                },
                "CreateTime": "2022-05-20T13:00:55Z"
            }
        ]
    }
}

错误码

本接口无特有错误码,公共错误码请参见 公共错误码