ListInstanceEndpoint

Updated at: 2025-03-24 08:29

Queries the endpoints of a Container Registry instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
cr:ListInstanceEndpointget
*Instance
acs:cr:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

cri-kmsiwlxxdcva****
ModuleNamestringNo

The name of the module that you want to access. Valid values:

  • Registry: image repositories.
  • Chart: Helm charts.
Chart
SummarybooleanNo

Specify whether to return endpoints in simple mode. If yes, no access control information about the endpoint is returned.

false

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
Codestring

The return value.

success
IsSuccessboolean

Indicates whether the request is successful.

true
RequestIdstring

The request ID.

1B21A877-66A2-4095-90EB-20A7781A4A67
Endpointsarray<object>

The endpoints of the instance.

Endpointsobject
Statusstring

The status of the endpoint.

RUNNING
EndpointTypestring

The type of the endpoint.

internet
AclEnableboolean

Indicates whether the endpoint is added to an access control list (ACL).

true
Enableboolean

Indicates whether the endpoint is added to an ACL.

true
Domainsarray<object>

The list of domain names of the Container Registry instance.

Domainsobject
Typestring

The type of the domain name. Valid values:

  • SYSTEM: system domain name.
  • USER: user domain name.
SYSTEM
Domainstring

The domain name of the Container Registry instance.

t****-registry.cn-shanghai.cr.aliyuncs.com
LinkedVpcsarray<object>

The VPCs associated with the instance.

LinkedVpcsobject
VpcIdstring

VPC ID

null
AclEntriesarray<object>

The ACLs that are configured for the instance.

AclEntriesobject
Entrystring

The information about the ACL.

null

Examples

Sample success responses

JSONformat

{
  "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": "null"
        }
      ],
      "AclEntries": [
        {
          "Entry": "null"
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError message
HTTP status codeError codeError message
403NoPrivilegeAccess denied for this user.
500SystemErrorUnknown error.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2024-01-23The Error code has changed. The request parameters of the API has changedView Change Details
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback