GetInstanceEndpoint

Updated at: 2024-12-27 02:29

Queries an endpoint of an 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:
    • 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
OperationAccess levelResource typeCondition keyAssociated operation
cr:GetInstanceEndpointget
*Instance
acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

cri-xkx6vujuhay0****
EndpointTypestringYes

The type of the endpoint. Set the value to Internet.

internet
ModuleNamestringNo

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

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

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
Statusstring

The status of the instance.

RUNNING
RequestIdstring

The ID of the request.

8F3D5EC5-39D1-4C53-A198-48C54C658FA3
Codestring

The return value.

success
IsSuccessboolean

Indicates whether the request is successful.

true
AclEnableboolean

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

true
Enableboolean

Indicates whether the ACL feature is enabled.

true
Domainsarray<object>

Domain names.

Endpointsobject
Typestring

The type of the domain name. Valid values:

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

The domain name that is used to access the Container Registry Enterprise Edition instance.

shanghai-instance1-registry.cn-shanghai.cr.aliyuncs.com
AclEntriesarray<object>

The ACLs.

AclEntriesobject
Commentstring

Remarks for public IP address whitelists.

1
Entrystring

The public IP address whitelist.

192.168.1.0/24

Examples

Sample success responses

JSONformat

{
  "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 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
No change history
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare