Use GetInstanceEndpoint to query an instance endpoint - Container Registry - Alibaba Cloud - Container Registry

Queries an endpoint of an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cr:GetInstanceEndpoint

get

*Instance

acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	cri-xkx6vujuhay0****
EndpointType	string	Yes	The type of the endpoint. Set the value to Internet.	internet
ModuleName	string	No	The module to access. Valid values: `Registry`: the image repository. `Chart`: a Helm chart.	Registry

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the instance.	RUNNING
RequestId	string	The ID of the request.	8F3D5EC5-39D1-4C53-A198-48C54C658FA3
Code	string	The return value.	success
IsSuccess	boolean	Whether the request is successful.	true
AclEnable	boolean	Whether the access control list (ACL) feature is enabled.	true
Enable	boolean	Whether the ACL feature is enabled.	true
Domains	array<object>	Domain names.
	object
Type	string	The type of the domain name. Valid values: `SYSTEM`: a system domain name. `USER`: a user domain name.	SYSTEM
Domain	string	The domain name used to access the Container Registry Enterprise Edition instance.	shanghai-instance1-registry.cn-shanghai.cr.aliyuncs.com
AclEntries	array<object>	The ACLs.
	object
Comment	string	Remarks for public IP address whitelists.	1
Entry	string	The public IP address whitelist.	192.168.1.0/24

Examples

Success response

JSON format

{
  "Status": "RUNNING",
  "RequestId": "8F3D5EC5-39D1-4C53-A198-48C54C658FA3",
  "Code": "success",
  "IsSuccess": true,
  "AclEnable": true,
  "Enable": true,
  "Domains": [
    {
      "Type": "SYSTEM",
      "Domain": "shanghai-instance1-registry.cn-shanghai.cr.aliyuncs.com"
    }
  ],
  "AclEntries": [
    {
      "Comment": "1",
      "Entry": "192.168.1.0/24"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	SystemError	Unknown error.
403	NoPrivilege	Access denied for this user.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.