You need to enable JavaScript to run this app.
导航
镜像仓库
  • 文档首页
    • /
  • 镜像仓库

返回数据结构

最近更新时间：2024.03.12 15:03:45

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

我的收藏

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

Registry

参数名类型示例值描述
NameStringtest-registry镜像仓库实例名称。
TypeStringBasic镜像仓库实例类型，参数值说明如下：
  • Basic：基础版实例。仅部分历史版本用户支持使用，不支持在控制台查看。
  • Trial：体验版实例。
  • Enterprise：标准版实例。
ChargeTypeStringPostCharge镜像仓库实例的付费类型，目前仅支持 PostCharge 按量付费模式。

Status

Object<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]}：异常
CreateTimeString2022-05-20T13:00:55Z创建镜像仓库实例的时间。RFC3339 格式的 UTC+0 时间。

RegistryStatus

Phase、Condition 组合说明，请参见本文上方 Registry 中的 Status 参数说明。

参数名类型示例值描述

Phase

String

Deleting

镜像仓库实例状态，参数值如下：

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

Conditions

List

["Progressing"]

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

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

Namespace

参数名类型示例值描述
NameStringns1命名空间名称。
ProjectStringprojectaNamespace 所属项目的名称。该参数为空时，表示创建的 Namespace 不属于任何项目。
CreateTimeString2022-05-20T13:00:55Z创建命名空间的时间。RFC3339 格式的 UTC+0 时间。

Repository

参数名类型示例值描述
NamespaceStringns1命名空间名称。
NameStringrepo1OCI 制品仓库名称。
AccessLevelStringPrivate访问等级：
  • Private：私有类型 OCI 制品仓库，访问时需要访问密钥。
  • Public：公有类型 OCI 制品仓库，支持通过访问地址直接访问。
DescriptionStringThis is a description镜像仓库描述，描述长度为 0~300 个 UTF-8 字符。
CreateTimeString2022-05-20T13:00:55Z创建 OCI 制品仓库的时间。RFC3339 格式的 UTC+0 时间。
UpdateTimeString2022-05-20T13:00:55Z最近一次更新 OCI 制品仓库的时间。RFC3339 格式的 UTC+0 时间。

Tag

参数名类型示例值描述
NameStringv2OCI 制品版本（Tag）名称。
TypeStringImageOCI 制品 Tag 类型：
  • Image：该 Tag 对应一个容器镜像。
  • Chart：该 Tag 对应一个 Helm Chart。
DigestStringsha256:dd97a3eb42********OCI 制品摘要，SHA256 值。
PushTimeString2022-05-03T12:08:01ZOCI 制品最近一次推送的时间。RFC3339 格式的 UTC+0 时间。
SizeLong10061844OCI 制品大小，单位为 Byte。
ImageAttributesList<ImageAttribute>Tag 类型为 Image 时的相关属性，详情请参见 ImageAttribute。
ChartAttributeChartAttributeTag 类型为 Chart 时的相关属性，详情请参见 ChartAttribute。

ImageAttribute

参数名类型示例值描述
AuthorStringuser@test.com镜像的创建者，即上传该镜像到镜像仓库的火山引擎账号。
ArchitectureStringamd64镜像架构。
OsStringlinux镜像支持的操作系统。
DigestStringsha256:dd97a3eb42********镜像摘要，SHA256 值。

ChartAttribute

参数名类型示例值描述
ApiVersionStringv2Helm 版本。
NameStringmysqlHelm Chart 名称。
VersionString8.6.1Helm Chart 版本。

Domain

参数名类型示例值描述

Domain

String

helm-cr-cn-beijing.cr.volces.com

镜像仓库域名：

  • 体验版实例域名：
    • 存量实例：cr-cn-beijing.volces.com
    • 新建或升级后的实例：[实例名]-[地域].cr.volces.com
  • 标准版实例域名：[实例名]-[地域].cr.volces.com

Type

String

System

域名类型：

  • System ：系统提供的域名。
  • Volcengine：火山引擎域名。
  • ThirdParty：第三方域名。
CreateTimeString2022-05-20T13:00:55Z域名创建的时间，使用 RFC 3339 格式。

Default

Bool

true

该域名是否为镜像仓库系统域名。

  • true：默认域名。
  • false：不是默认域名。

Success

参数名类型示例值描述
NameStringv1Tag 的名称。

Failure

参数名类型示例值描述
NameStringv1Tag 的名称。
ReasonStringtag v1 not exist删除失败原因。

VpcInfo

参数名类型示例值描述
VpcIdStringvpc-luebclsohfwnljn****VPC ID。
SubnetIdStringsubnet-nlohebas****子网 ID。
RegionStringcn-beijingVPC 所在地域。
AccountIdInteger140000****VPC 归属的主账号 ID。
IpString192.168.12.33镜像仓库在 VPC 内的 IP 地址。

Status

String

Enabled

访问入口状态：

  • Enabling：开启中

  • Enabled：已开启

  • Disabling：关闭中

  • Failed：失败

CreateTimeString2022-05-20T13:00:55Z创建时间