Queries an endpoint of an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetInstanceEndpoint

The operation that you want to perform. Set the value to GetInstanceEndpoint.

EndpointType String Yes internet

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

InstanceId String Yes cri-xkx6vujuhay0tasd

The ID of the instance.

RegionId String Yes cn-shanghai

The ID of the region.

ModuleName String No Registry

The name of the module in the instance. Valid values: Registry and Chart.

Response parameters

Parameter Type Example Description
AclEnable Boolean true

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

AclEntries Array of AclEntries N/A

The access control entries configured for the instance.

Comment String 1 N/A
Entry String 192.168.1.0/24 N/A
Code String success

The return value.

Domains Array of Endpoints N/A

The domain names of the instance.

Domain String shanghai-instance1-registry.cn-shanghai.cr.aliyuncs.com N/A
Type String SYSTEM N/A
Enable Boolean true

Indicates whether the endpoint is enabled.

IsSuccess Boolean true

Indicates whether the operation is successful.

RequestId String 8F3D5EC5-39D1-4C53-A198-48C54C658FA3

The ID of the request.

Status String RUNNING

The status of the endpoint.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetInstanceEndpoint
&EndpointType=internet
&InstanceId=cri-xkx6vujuhay0tasd
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.