Obtain the public network access information of the 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 URL: https://cr.cn-beijing.volcengineapi.com?Action=GetPublicEndpoint&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	GetPublicEndpoint	The API name. The current API's name is GetPublicEndpoint.
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. On the Instance List page of the Container Registry Console, get the instance name.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Registry	String	registrya	The name of the Container Registry instance.
Enabled	Boolean	true	Indicates whether public network access is enabled. Possible parameter values: false: not enabled true: enabled
AclPolicies	Array of AclPolicy	["192.168.1.0/24"]	The list of public network IP allowlists.
Status	String	Enabled	The current status of the public network access. Possible parameter values: Enabling: turning on Enabled: turned on Disabling: turning off Updating: being updated Failed: failed Disabled: turned off

AclPolicy

Parameter	Type	Sample value	Description
Entry	String	192.168.1.0/24	The IP entry address.
Description	String	xxx	The IP entry description.

Sample responses

Error code

The error codes for this API are listed in the table below. 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.