You need to enable JavaScript to run this app.
导航

请求数据结构

最近更新时间2023.08.18 11:04:36

首次发布时间2022.06.14 21:29:04

本文主要描述镜像仓库 OpenAPI 的通用请求数据结构。

RegistryFilter

参数名类型是否必须示例值描述
NamesList<String>["test1", "jt*tt", "*test", "li*"]指定镜像仓库实例名称。在 镜像仓库控制台实例列表 页面,获取实例名称。

支持精确匹配和模糊匹配,模糊匹配仅支持使用星号(*)作为通配符。单次最多填写 20 个实例名称。

TypesList<String>["Basic"]镜像仓库实例类型。取值如下:
  • Basic:基础版实例。
  • Trial:体验版实例。
  • Enterprise:标准版实例。

可填写一个或多个实例类型。

StatusesList<StatusFilter>镜像仓库实例的状态,详情请参见 StatusFilter

单次调用最多可填写 10 个 StatusFilter 组合。

StatusFilter

有效的 PhaseCondition 组合,请参见 Registry 中的 Status 参数说明。

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

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 ] :异常。

ConditionStringOk

NamespaceFilter

参数名类型是否必须示例值描述
NamesList<String>["test", "*st", "t*st","tes*"]指定命名空间名称。在 镜像仓库控制台 目标实例的 命名空间 页面,获取命名空间名称。

支持精确匹配和模糊匹配,模糊匹配仅支持使用星号(*)作为通配符。单次最多填写 20 个命名空间名称。

RepositoryFilter

参数名类型是否必须示例值描述
NamespacesList<String>["testns"]指定 OCI 制品仓库所属的命名空间。在 镜像仓库控制台 目标实例的 命名空间 页面,获取命名空间名称。

支持精确匹配和模糊匹配,模糊匹配仅支持使用星号(*)作为通配符。单次最多填写 20 个命名空间名称。

NamesList<String>["test", "*st", "t*st","tes*"]指定 OCI 制品仓库名称。在 镜像仓库控制台 目标实例的 OCI制品仓库 页面,获取 OCI 制品仓库名称。

支持精确匹配和模糊匹配,模糊匹配仅支持使用星号(*)作为通配符。单次最多填写 20 个 OCI 制品仓库名称。

AccessLevelsList<String>["Private"]访问等级,取值如下:
  • Private:私有类型 OCI 制品仓库,只能被有权限的用户访问。
  • Public:公有类型 OCI 制品仓库,可以被所有用户访问。

单次可填写一个或多个访问等级。

TagFilter

参数名类型是否必须示例值描述
NamesList<String>["tag"]指定 Tag,支持精确匹配和模糊匹配,模糊匹配仅支持使用 * 号作为通配符,最多 20 个
TypesList<String>["Chart"]OCI 制品 Tag 类型,取值如下:
  • Image:该 Tag 对应一个容器镜像。
  • Chart:该 Tag 对应一个 Helm Chart。

单次可填写一个或多个Tag 类型。

VpcMeta

参数名类型是否必须示例值描述
VpcIdStringvpc-3rfawyc34g0sg5zsk2idd****VPC ID,镜像仓库实例会在该 VPC 内配置访问入口。
SubnetIdStringsubnet-jhhsrhjjdfssi****VPC 下的子网 ID。若不指定则自动选取 VPC 下剩余 IP 最多的子网,并且选定后不可更改。
AccountIdInteger140000****VPC 归属的主账号的 ID。当需要把标准版实例暴露给另一个主账号下的 VPC 使用时,需要指定该 ID。

VpcEndpointFilter

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

Statuses

List

["Enabling", "Enabled"]

VPC 访问入口状态数组,用于过滤出处于指定状态的 VPC 访问入口。

  • Enabling:开启中

  • Enabled:已开启

  • Disabling:关闭中

  • Failed:失败