Queries an endpoint of an instance.
Debugging
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. Valid values: Internet and VPC. |
InstanceId | String | Yes | cri-xkx6vujuhay0tasd |
The ID of the instance. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where the instance resides. |
ModuleName | String | No | Registry |
The name of the module in the instance. Valid values: Registry and Chart. |
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 | 8F3D5EC5-39D1-4C53-A198-48C54C658FA3 |
The ID of the request. |
Enable | Boolean | true |
Indicates whether the endpoint is enabled. |
AclEnable | Boolean | true |
Indicates whether access control to the instance from the endpoint is enabled. This parameter is returned only when the type of the endpoint is Internet. |
Status | String | RUNNING |
The status of the endpoint. This parameter is returned only when the type of the endpoint is Internet. |
Domains | Array |
A list of domain names of the instance. |
|
Domain | String | shanghai-instance1-registry.cn-shanghai.cr.aliyuncs.com | |
Type | String | SYSTEM | |
AclEntries | Array |
A list of access control entries configured for the instance. This parameter is returned only when the type of the endpoint is Internet. |
|
Entry | String | 192.168.1.0/24 | |
Comment | String | 1 |
Examples
Sample requests
http(s)://[Endpoint]/? Action=GetInstanceEndpoint
&EndpointType=internet
&InstanceId=cri-xkx6vujuhay0tasd
&RegionId=cn-shanghai
&<Common request parameters>
Sample success responses
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"
}
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>
Error codes
For a list of error codes, visit the API Error Center.