Query one or more Container Registry instances.

API description

When querying Container Registry instances, use the Filter parameter to control the filtering conditions for the Container Registry instances.

Request description

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

Request method: POST

Request address: https://cr.cn-beijing.volcengineapi.com?Action=ListRegistries&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	ListRegistries	The API name. The current API's name is ListRegistries.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Filter	Object of RegistryFilter	No		The filtering conditions for the Container Registry instances to be queried.
ResourceTagFilters	Array of ResourceTagFilter	No		The filtering conditions for querying the labels of Container Registry instances.
PageSize	Long	No	10	The number of Container Registry instances displayed per page. With a default value of 10, it takes integer values within the range [1,100].
PageNumber	Long	No	1	The page number from which to start displaying the returned results. It starts from 1, with a default value of 1, and takes integer values within the range [1, 2147483647].

RegistryFilter

Parameter	Type	Required	Sample value	Description
Names	Array of String	No	["registrya", "registryb"]	The names of the specified Container Registry instances or proxy cache registries. You can obtain the names of instances or proxy cache registries from the Instances or Proxy Cache page in the Container Registry Console. Supports both exact and fuzzy matching. Fuzzy matching only supports using the asterisk (*) as a wildcard. A maximum of 20 instance names or proxy cache registry names can be specified in a single request.
Types	Array of String	No	["Micro","Enterprise"]	The type of the Container Registry instance. Valid values: Basic: basic instance. Trial: trial instance. Enterprise: standard instance. Micro: The Micro Edition instance. You can fill in one or more instance types.
Projects	Array of String	No	["default","projecta"]	The names of the associated projects.
Statuses	Array of StatusFilter	No		The statuses of the registry instances. You can fill in up to 10 StatusFilter combinations at a time.

ResourceTagFilter

Parameter	Type	Required	Sample value	Description
Key	String	Yes	key1	The Key value of the label.
Values	Array of String	Yes	["value1","value2"]	Label value.

StatusFilter

Parameter	Type	Required	Sample value	Description
Phase	String	No	Running	The instance status (Status) is composed of Phase and Conditions. Creating, [ Progressing ]: The instance is being created. Running, [ Ok ]: The instance is running normally. Running, [ Degraded ]: Running. Stopped, [ Balance ]: shutdown due to arrears. Stopped, [ Released ]: To be recycled. Stopped, [ Released, Balance ]: shutdown due to arrears. Starting, [ Progressing ]: Starting. Deleting, [ Progressing ]: Destroying. Failed, [ Unknown ]: Abnormal.
Condition	String	No	Ok	The instance status (Status) is composed of Phase and Conditions. Creating, [ Progressing ]: The instance is being created. Running, [ Ok ]: The instance is running normally. Running, [ Degraded ]: running. Stopped, [ Balance ]: shutdown due to arrears. Stopped, [ Released ]: to be recycled. Stopped, [ Released, Balance ]: shutdown due to arrears. Starting, [ Progressing ]: starting. Deleting, [ Progressing ]: destroying. Failed, [ Unknown ]: abnormal.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
TotalCount	Long	1	The number of Container Registry instances queried.
PageNumber	Long	1	The current page number.
PageSize	Long	10	The number of Container Registry instance information items displayed per page.
Items	Array of Registry		The list of Container Registry instances.

Registry

Parameter	Type	Sample value	Description
Name	String	test-registry	The name of the Container Registry instance.
Type	String	Basic	The type of the Container Registry instance. The parameter values are as follows: Basic: basic instance. Only some users of historical versions are supported to use, and it can not be viewed in the console. Trial: trial instance. Enterprise: standard instance. Micro: The Micro Edition instance.
ChargeType	String	PostCharge	The payment type of the Container Registry instance. Currently, only the PostCharge Pay-as-you-go mode is supported.
Status	Object of RegistryStatus	{ "Phase": "Running", "Conditions": ["Ok"] }	The status of the Container Registry instance, composed of Phase and Conditions. The valid combinations of Phase and Conditions are as follows: {Creating, [Progressing]}: creating. {Running, [Ok]}: running. {Running, [Degraded]}: running. {Stopped, [Balance]}: shutdown due to arrears. {Stopped, [Released]}: to be recycled. {Stopped, [Released, Balance]}: shutdown due to arrears. {Starting, [Progressing]}: starting. {Deleting, [Progressing]}: destroying. {Failed, [Unknown]}: abnormal.
Project	String	projecta	The project to which the instance needs to be associated. Each instance supports association with only one project.
ResourceTags	Array of ResourceTag		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.
CreateTime	String	2022-05-20T13:00:55Z	The time when the Container Registry instance was created. UTC+0 time in standard RFC3339 format.
ExpireTime	String	2022-05-20T13:00:55Z	The expiration time of the instance or proxy cache registry. A return value exists only when the billing type is HybridCharge (mixed billing).
RenewType	String	Manual	The expiration time of the instance or proxy cache registry. A return value exists only when the billing type is HybridCharge (mixed billing).
ProxyCache	Object of ProxyCache	{ "Type": "Dockerhub" }	The configuration description of the proxy cache registry.
ProxyCacheEnabled	Boolean	true	Indicates whether it is a proxy cache registry.

RegistryStatus

Parameter	Type	Sample value	Description
Phase	String	Running	The phase part of the instance status, together with Condition, constitutes the instance status. Supported values are as follows. Creating: creating. Running: running. Stopped: stopped state (includes shutdown due to arrears, to be recycled, and other sub-states). Starting: starting. Deleting: destroying. Failed: abnormal.
Conditions	Array of String	["Ok"]	The conditions or reasons for the CR instance entering the current state. Multiple values can be included. Supported values are as follows: Ok: instance status is normal. Progressing: the instance is in the process of an operation (such as create, start, or destroy). Degraded: the instance is running but with limited performance or features. Balance: the instance status is abnormal due to arrears. Released: the instance is to be recycled. Unknown: the instance status is unknown or abnormal.

ResourceTag

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

ProxyCache

Parameter	Type	Sample value	Description
Type	String	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.

Sample responses

Error code

This interface has no specific error codes. For public error codes, please refer to the Public error codes documentation.