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
Action String Yes ListInstanceEndpoint

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

InstanceId String Yes cri-kmsiwlxxdcva****

The ID of the instance.

RegionId String Yes cn-shanghai

The ID of the region.

ModuleName String No Chart

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

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

Response parameters

Parameter Type Example Description
Code String success

The return value.

Endpoints Array of Endpoints

The endpoints of the instance.

AclEnable Boolean true

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

AclEntries Array of AclEntries

The access control entries configured for the instance.

Entry String null

The information about an access control entry.

Domains Array of Domains

The domain names of the instance.

Domain String t****-registry.cn-shanghai.cr.aliyuncs.com

The domain name of the instance.

Type String SYSTEM

The type of the domain name.

Enable Boolean true

Indicates whether the endpoint is enabled.

EndpointType String internet

The type of the endpoint.

LinkedVpcs Array of LinkedVpcs

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

VpcId String null

VPC ID

Status String RUNNING

The status of the endpoint.

IsSuccess Boolean true

Indicates whether the operation is successful.

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

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

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

JSON format

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

Error codes

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