CreateRegistry--镜像仓库-火山引擎

文档中心

立即注册

导航

CreateRegistry

最近更新时间：2024.11.28 11:20:00首次发布时间：2022.06.14 21:29:03

创建镜像仓库标准版实例。

接口说明

此接口为异步接口，当调用接口并返回成功后，需要您调用 ListRegistries 接口获取该标准版实例当前的状态。当标准版实例状态变为{Running, [*]}时，开始计费。计费详情，请参见产品计费。

单个火山引擎账号在各地域（Region）最多可创建的标准版实例数量如下。更多地域相关说明参见公共参数。

地域	Region	数量
华北 2 (北京)	cn-beijing	3
华南 1 (广州)	cn-guangzhou	1
华东 2 (上海)	cn-shanghai	1

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	CreateRegistry	接口名称。当前 API 的名称为 `CreateRegistry`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Name	String	是	exampleregistry	标准版实例名称，同一个地域下，名称必须唯一。支持小写英文字母、数字、短划线（-）且数字不能在首位，短划线（-）不能在首位或末位，长度限制为 3～30 个字符。
Type	String	否	Enterprise	不填写默认创建标准版实例。 Enterprise：标准版 Micro：小微版
Project	String	否	default	填写实例需要关联的项目。一个实例仅支持关联一个项目。
ResourceTags	Array of ResourceTag	否	参考通用数据结构	支持通过键值对，自定义实例的标签。支持在分账账单中基于实例标签查看账单信息，详情说明参见分账账单。
ClientToken	String	否	BC028527-33B9-4990-A633-84E9F9******	用于保证请求幂等性的字符串。该字符串由调用方传入，需保证不同请求之间唯一。ClientToken 对大小写敏感，且最大值不超过 64 个 ASCII 字符。
ProxyCacheEnabled	Boolean	否	true	是否为远端代理仓。
ProxyCache	Object of ProxyCacheSpec	否	{ "Type": "Dockerhub", "Username": "", "Password": "" }	远端代理仓配置，创建远端代理仓时必填。

ResourceTag

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

ProxyCacheSpec

参数	类型	是否必选	示例值	描述
Type	String	是	DockerHub	远端代理仓支持的类型。 DockerHub：Docker Hub 类型的远端代理仓，支持在大陆地区拉取 Docker Hub 中镜像。 DockerRegistry：通用类型的远端代理仓，可以支持多云场景中主备仓需求。
Endpoint	String	否	https://a.b.c.com	源镜像的访问地址。 DockerHub 类型：访问地址固定为 `https://hub.docker.com`。 DockerHub 以外的类型：需要指定具体的访问地址。
Password	String	否	5pWw5o2u5a6J5YWoCg==	访问源镜像所需的用户名或者 SecretAccessKey。
Username	String	否	username-1	访问源镜像所需的密码或者 AccessKeyID。
SkipSSLVerify	Boolean	否	true	是否忽略 SSL 证书验证。

请求示例

POST https://open.volcengineapi.com?Action=CreateRegistry&Version=2022-05-12
{
    "Name": "exampleregistry"
}

返回参数

无

返回示例

{
    "ResponseMetadata" : {
        "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
        "Action": "CreateRegistry",
        "Version": "2022-05-12",
        "Service": "cr",
        "Region": "cn-beijing",
    },
    "Result": {}
}

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	QuotaExceeded.Registry	The quota of cr registry is exceeded.	标准版实例数量已达到配额限制。产品限制说明，请参见使用限制。若确定需要提高配额，可提交工单申请。