Query instance endpoints with ListInstanceEndpoint - Container Registry - Alibaba Cloud - Container Registry

Queries the endpoints of a Container Registry 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:ListInstanceEndpoint

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-kmsiwlxxdcva****
ModuleName	string	No	The name of the module that you want to access. Valid values: `Registry`: image repositories. `Chart`: Helm charts.	Registry
Summary	boolean	No	Specify whether to return endpoints in simple mode. If yes, no access control information about the endpoint is returned.	false

Response elements

Element	Type	Description	Example
	object
Code	string	The return value.	success
IsSuccess	boolean	Indicates whether the request is successful.	true
RequestId	string	The request ID.	1B21A877-66A2-4095-90EB-20A7781A4A67
Endpoints	array<object>	The endpoints of the instance.
	array<object>
Status	string	The status of the endpoint.	RUNNING
EndpointType	string	The type of the endpoint.	internet
AclEnable	boolean	Indicates whether the endpoint is added to an access control list (ACL).	true
Enable	boolean	Indicates whether the endpoint is added to an ACL.	true
Domains	array<object>	The list of domain names of the Container Registry instance.
	object
Type	string	The type of the domain name. Valid values: SYSTEM: system domain name. USER: user domain name.	SYSTEM
Domain	string	The domain name of the Container Registry instance.	t****-registry.cn-shanghai.cr.aliyuncs.com
LinkedVpcs	array<object>	The VPCs associated with the instance.
	object
VpcId	string	VPC ID	vpc-bp1b1xjllp3ve5yze****
AclEntries	array<object>	The ACLs that are configured for the instance.
	object
Entry	string	The information about the ACL.	127.0.0.1

Examples

Success response

JSON format

{
  "Code": "success",
  "IsSuccess": true,
  "RequestId": "1B21A877-66A2-4095-90EB-20A7781A4A67",
  "Endpoints": [
    {
      "Status": "RUNNING",
      "EndpointType": "internet",
      "AclEnable": true,
      "Enable": true,
      "Domains": [
        {
          "Type": "SYSTEM",
          "Domain": "t****-registry.cn-shanghai.cr.aliyuncs.com"
        }
      ],
      "LinkedVpcs": [
        {
          "VpcId": "vpc-bp1b1xjllp3ve5yze****"
        }
      ],
      "AclEntries": [
        {
          "Entry": "127.0.0.1"
        }
      ]
    }
  ]
}

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.