Create Container Registry instance.

API description

This interface is an asynchronous one. After successfully calling the interface and receiving a positive response, you need to call the ListRegistries interface to obtain the current status of the Standard Edition instance. When the status of the Standard Edition instance changes to {Running, [*]}, billing will start. For billing details, please refer to Product billing.

The maximum number of Standard Edition CR instances that can be created by a single Volcano Engine root user in each region is specified in Limit.

Request description

To achieve low latency, it is recommended to select the corresponding Service address according to the region where your resources are located. For details, see Service address.

Request method: POST

Request address: https://cr.cn-beijing.volcengineapi.com?Action=CreateRegistry&Version=2022-05-12

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

When calling this API, in addition to the following request parameters, you also need to provide the public request parameters. See Public parameters for details.

Parameter	Type	Required	Sample value	Description
Action	String	Yes	CreateRegistry	The API name. The current API's name is CreateRegistry.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Name	String	Yes	exampleregistry	The name of the Standard Edition instance, which must be unique within the same region. It supports lowercase English letters, numbers, and hyphens (-), but numbers can not appear at the beginning, and hyphens (-) can not appear at the beginning or end. The length limit is 3 to 30 characters.
Type	String	No	Enterprise	If not filled in, a Standard Edition instance will be created by default. Enterprise: the Standard Edition Micro: the Micro Edition
Project	String	No	default	The project to which the instance needs to be associated. Each instance supports association with only one project.
ResourceTags	Array of ResourceTag	No	Refer to the general data structure	Allow customizing instance labels using key-value pairs. You can view billing information based on instance tags in the splitting bills. For details, see Splitting bills.
ClientToken	String	No	BC028527-33B9-4990-A633-84E9F9******	A string used to ensure the idempotency of the request. This string is passed in by the caller and must be unique across different requests. ClientToken is case-sensitive and can consist of 64 ASCII characters at most.
ProxyCacheEnabled	Boolean	No	true	Indicates whether it is a proxy cache registry.
ProxyCache	Object of ProxyCacheSpec	No	{ "Type": "Dockerhub", "Username": "", "Password": "" }	The configuration for the proxy cache registry. It is required when creating a proxy cache registry.

ResourceTag

Parameter	Type	Required	Sample value	Description
Key	String	Yes	key1	The Key value of the label.
Value	String	Yes	val1	The list of values for the label.

ProxyCacheSpec

Parameter	Type	Required	Sample value	Description
Type	String	Yes	DockerHub	The type supported by the proxy cache registry. DockerHub: A proxy cache registry of the Docker Hub type, which supports pulling images from Docker Hub in the mainland region. DockerRegistry: A general-purpose proxy cache registry, which supports the requirements for primary and secondary registries in multi-cloud scenarios.
Endpoint	String	No	https://***.com	The access address of the source image. DockerHub type: The access address is fixed as https://hub.docker.com. For types other than DockerHub: A specific access address needs to be specified.
Password	String	No	5pWw5o2u5a6J5YWo****	Password or AccessKeySecret required for access to the source image.
Username	String	No	username-1	Username or AccessKeyID required for access to the source image.
SkipSSLVerify	Boolean	No	true	Indicates whether to ignore SSL certificate verification.

Sample requests

Response parameters

None

Sample responses

Error code

The error codes for this API are listed in the table below. For public error codes, see Public error codes.

HTTP status code	Error code	Error message	Description
400	QuotaExceeded.Registry	The quota of cr registry is exceeded.	The number of instances has reached the quota limit. For product limit descriptions, please refer to the Limit documentation. If you definitely need to increase the quota, you can submit a ticket to apply.