查询一个或多个镜像仓库实例。
查询镜像仓库实例时,通过 Filter 参数,控制镜像仓库实例的筛选条件。
调用该 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] 的整数。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Names | Array of String | 否 | ["registrya", "registryb"] | 指定镜像仓库实例或远端代理仓名称。在 镜像仓库控制台 的 实例列表 或 远端代理 页面,获取实例或远端代理仓的名称。 |
Types | Array of String | 否 | ["Micro","Enterprise"] | 镜像仓库实例类型。取值如下:
|
Projects | Array of String | 否 | ["default","projecta"] | 关联的项目名称。 |
Statuses | Array of StatusFilter | 否 | 镜像仓库实例的状态,单次调用最多可填写 10 个 StatusFilter 组合。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Key | String | 是 | key1 | 标签的 Key 值。 |
Values | Array of String | 是 | ["value1","value2"] | 标签的 Value 值。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Phase | String | 否 | Running | 实例状态(Status)由 Phase 和 Conditions 组成。
|
Condition | String | 否 | Ok | 实例状态(Status)由 Phase 和 Conditions 组成。 |
POST https://open.volcengineapi.com?Action=ListRegistries&Version=2022-05-12 { "Filter": { "Names": ["example"] } }
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Long | 1 | 查询到的镜像仓库实例数量。 |
PageNumber | Long | 1 | 当前页码。 |
PageSize | Long | 10 | 单页显示的镜像仓库实例信息条数。 |
Items | Array of Registry | 镜像仓库实例列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String | test-registry | 镜像仓库实例名称。 |
Type | String | Basic | 镜像仓库实例类型,参数值说明如下:
|
ChargeType | String | PostCharge | 镜像仓库实例的付费类型,目前仅支持 PostCharge 按量付费模式。 |
Status | Object of RegistryStatus | { | 镜像仓库实例状态,由 Phase 和 Conditions 组成。
|
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 | { | 远端代理仓配置说明。 |
ProxyCacheEnabled | Boolean | true | 是否为远端代理仓。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Phase | String | Running | 镜像仓库实例状态,参数值如下:
|
Conditions | Array of String | ["ok"] | 镜像仓库实例进入当前状态下的条件、即进入该状态的原因等,可以有多个原因。参数值如下:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | key1 | 标签的 Key 值。 |
Value | String | val1 | 标签的 Value 值列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Type | String | DockerHub | 远端代理仓支持的类型。
|
{ "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" } ] } }
本接口无特有错误码,公共错误码请参见 公共错误码。