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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
InstanceId String Yes cri-kmsiwlxxdcvaduwb

The ID of the instance.

RegionId String Yes cn-shanghai

The ID of the region.

ModuleName String No Chart

The name of the module in the instance.

Response parameters

Parameter Type Example Description
IsSuccess Boolean true

Indicates whether the operation is successful.

Code String success

The return value.

RequestId String 1B21A877-66A2-4095-90EB-20A7781A4A67

The ID of the request.

Endpoints Array N/A

The endpoints of the instance.

EndpointType String internet

The type of the endpoint.

Enable Boolean true

Indicates whether the endpoint is enabled.

AclEnable Boolean true

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

Status String RUNNING

The status of the endpoint.

Domains Array N/A

The domain names of the instance.

Domain String test-registry.cn-shanghai.cr.aliyuncs.com

The domain name of the instance.

Type String SYSTEM

The type of the domain name.

LinkedVpcs Array N/A

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

VpcId String null

The ID of the VPC.

AclEntries Array N/A

The access control entries configured for the instance.

Entry String null

The information about an access control entry.

Examples

Sample requests

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

Sample success responses

XML format

<Endpoints>
    <Status>RUNNING</Status>
    <Domains>
        <Type>SYSTEM</Type>
        <Domain>acr-test-registry.cn-shanghai.cr.aliyuncs.com</Domain>
    </Domains>
    <AclEnable>true</AclEnable>
    <EndpointType>internet</EndpointType>
    <Enable>true</Enable>
</Endpoints>
<IsSuccess>true</IsSuccess>
<RequestId>1B21A877-66A2-4095-90EB-20A7781A4A67</RequestId>
<Code>success</Code>

JSON format

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

Error codes

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