Queries endpoints of an instance.
Debugging
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-kmsiwlxxdcvaduwb |
The ID of the instance. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where the instance resides. |
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 code returned for the request. |
RequestId | String | 1B21A877-66A2-4095-90EB-20A7781A4A67 |
The ID of the request. |
Endpoints | Array |
A list of 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 is enabled. This parameter is returned only when the endpoint type is Internet. |
Status | String | RUNNING |
The status of the endpoint. This parameter is returned only when the endpoint type is Internet. |
Domains | Array |
A list of 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 |
A list of VPCs associated with the instance. |
|
VpcId | String | null |
The ID of the VPC. |
AclEntries | Array |
A list of access control entries configured for the instance. This parameter is returned only when the endpoint type is Internet. |
|
Entry | String | null |
The information about the access control entry configured for the instance. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=ListInstanceEndpoint
&InstanceId=cri-kmsiwlxxdcvaduwb
&RegionId=cn-shanghai
&<Common request parameters>
Sample success responses
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"
}
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>
Error codes
For a list of error codes, visit the API Error Center.