All Products
Search
Document Center

Container Registry:ListInstanceEndpoint

Last Updated:Mar 01, 2024

Queries endpoints of an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
cr:ListInstanceEndpointRead
  • Instance
    acs:cr:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

cri-kmsiwlxxdcva****
ModuleNamestringNo

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

  • Registry: the image repository.
  • Chart: a Helm chart.
Chart

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The return value.

success
IsSuccessboolean

Indicates whether the request is successful.

true
RequestIdstring

The ID of the request.

1B21A877-66A2-4095-90EB-20A7781A4A67
Endpointsobject []

The endpoints of the instance.

Statusstring

The status of the instance.

RUNNING
EndpointTypestring

The type of the endpoint.

internet
AclEnableboolean

Indicates whether the access control list (ACL) feature is enabled.

true
Enableboolean

Indicates whether the ACL feature is enabled.

true
Domainsobject []

Domain names.

Typestring

Type

SYSTEM
Domainstring

The domain name.

t****-registry.cn-shanghai.cr.aliyuncs.com
LinkedVpcsobject []

The virtual private clouds (VPCs) that are associated with the instance.

VpcIdstring

VPC ID

null
AclEntriesobject []

The ACL configured for the instance.

Entrystring

Details 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
403NoPrivilegeAccess denied for this user.
500SystemErrorUnknown error.

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

Change history

Change timeSummary of changesOperation
2024-01-23The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Summary