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

接口说明

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

请求说明

为获得低延迟，建议您根据资源所在的地域选择对应的服务地址，详情参见服务地址。

请求方式：POST

请求地址：https://cr.cn-beijing.volcengineapi.com?Action=ListRegistries&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时，除了以下请求参数外，还需传入公共请求参数。公共请求参数说明，请参见公共参数。

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

RegistryFilter

参数	类型	是否必选	示例值	描述
Names	Array of String	否	["registrya", "registryb"]	指定镜像仓库实例或远端代理仓名称。在镜像仓库控制台的实例列表或远端代理页面，获取实例或远端代理仓的名称。支持精确匹配和模糊匹配，模糊匹配仅支持使用星号（*）作为通配符。单次最多填写 20 个实例或远端代理仓名称。
Types	Array of String	否	["Micro","Enterprise"]	镜像仓库实例类型。取值如下： Basic：基础版实例。 Trial：体验版实例。 Enterprise：标准版实例。 Micro：小微版实例。可填写一个或多个实例类型。
Projects	Array of String	否	["default","projecta"]	关联的项目名称。
Statuses	Array of StatusFilter	否		镜像仓库实例的状态，单次调用最多可填写 10 个 StatusFilter 组合。

ResourceTagFilter

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

StatusFilter

参数	类型	是否必选	示例值	描述
Phase	String	否	Running	实例状态（Status）由 Phase 和 Conditions 组成。 Creating, [ Progressing ] ：创建中。 Running, [ Ok ] ：运行中。 Running, [ Degraded ] ：运行中。 Stopped, [ Balance ] ：欠费关停。 Stopped, [ Released ] ：待回收。 Stopped, [ Released, Balance ] ：欠费关停。 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 ] ：异常。

请求示例

返回参数

参数	类型	示例值	描述
TotalCount	Long	1	查询到的镜像仓库实例数量。
PageNumber	Long	1	当前页码。
PageSize	Long	10	单页显示的镜像仓库实例信息条数。
Items	Array of Registry		镜像仓库实例列表。

Registry

参数	类型	示例值	描述
Name	String	test-registry	镜像仓库实例名称。
Type	String	Basic	镜像仓库实例类型，参数值说明如下： Basic：基础版实例。仅部分历史版本用户支持使用，不支持在控制台查看。 Trial：体验版实例。 Enterprise：标准版实例。 Micro：小微版实例。
ChargeType	String	PostCharge	镜像仓库实例的付费类型，目前仅支持 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]}：异常。
Project	String	projecta	填写实例需要关联的项目。一个实例仅支持关联一个项目。
ResourceTags	Array of ResourceTag		支持通过键值对，自定义实例的标签。支持在分账账单中基于实例标签查看账单信息，详情说明参见分账账单。
CreateTime	String	2022-05-20T13:00:55Z	创建镜像仓库实例的时间。RFC3339 格式的 UTC+0 时间。
ExpireTime	String	2022-05-20T13:00:55Z	实例或远端代理仓到期时间。仅计费类型为 HybridCharge 混合计费时存在返回值。
RenewType	String	Manual	实例或远端代理仓到期时间。仅计费类型为 HybridCharge 混合计费时存在返回值。
ProxyCache	Object of ProxyCache	{ "Type": "Dockerhub" }	远端代理仓配置说明。
ProxyCacheEnabled	Boolean	true	是否为远端代理仓。

RegistryStatus

参数	类型	示例值	描述
Phase	String	Running	实例状态的阶段部分，与Condition共同组成实例状态。支持的取值如下所示。 Creating：创建中。 Running：运行中。 Stopped：停止状态（包含欠费关停、待回收等子状态）。 Starting：启动中。 Deleting：销毁中。 Failed：异常。
Conditions	Array of String	["Ok"]	镜像仓库实例进入当前状态的条件或原因，可包含多个值。支持的取值如下： Ok：实例状态正常。 Progressing：实例处于操作过程中（如创建、启动、销毁）。 Degraded：实例运行中但性能或功能受限。 Balance：实例因欠费导致状态异常。 Released：实例待回收。 Unknown：实例状态未知或异常。

ResourceTag

参数	类型	示例值	描述
Key	String	key1	标签的 Key 值。
Value	String	val1	标签的 Value 值列表。

ProxyCache

参数	类型	示例值	描述
Type	String	DockerHub	远端代理仓支持的类型。 DockerHub：Docker Hub 类型的远端代理仓，支持在大陆地区拉取 Docker Hub 中镜像。 DockerRegistry：通用类型的远端代理仓，可以支持多云场景中主备仓需求。

返回示例

错误码

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