Queries the domain names of a Container Registry instance.

Request description

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

Request method: POST

Request address: https://cr.cn-beijing.volcengineapi.com?Action=ListDomains&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	ListDomains	The API name. The current API's name is ListDomains.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Registry	String	Yes	registrya	The name of the Container Registry instance for which domain names are to be queried.
PageSize	Long	no	10	The number of domain name information items 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].

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Registry	String	registrya	The name of the Container Registry instance.
TotalCount	Long	1	The total number of domain names.
PageNumber	Long	1	The current page number.
PageSize	Long	10	The number of domain name information items displayed per page.
Items	Array of Domain	[{"Domain": "aaa.com", "Type": "System", "CreateTime": "2022-05-20T13:00:55Z"}]	The list of domain names for the Container Registry instance.

Domain

Parameter	Type	Sample value	Description
Domain	String	helm-cr-cn-beijing.cr.volces.com	The domain names of the Container Registry: Trial instance domain name: For existing instances: cr-cn-beijing.volces.com For upgraded instances: [Instance Name]-[Region].cr.volces.com For instances of other versions: [Instance Name]-[Region].cr.volces.com
Type	String	System	The type of the domain name: System: A domain name provided by the system. Volcengine: A Volcano Engine domain name. ThirdParty: A third-party domain name.
CreateTime	String	2022-05-20T13:00:55Z	The time when the domain name was created, in RFC 3339 format.
Default	Boolean	true	Whether the domain name is the system domain name of the Container Registry. true: It is the default domain name. false: It is not the default domain name.

Sample responses

Error code

The error codes for this interface are shown in the following table. For public error codes, refer to public error codes.

HTTP Status Code	Error code	Error Message	Descriptions
400	OperationDenied.RegistryStatus	The action has been denied due to wrong status %s.	The specified operation is not allowed under the current instance status. Please wait for the status transition to complete and try again.