Description
Obtains information about a cluster instance.
Request syntax
GET /clusters/{ClusterId}/groups/{GroupName}/instances/{InstanceId}
Attribute description
| Attribute |
Type |
Required |
Description |
| ClusterId |
String |
Yes |
Cluster ID. |
|
| GroupName |
String |
Yes |
Name of a group in the cluster |
|
| InstanceId |
String |
Yes |
ID of the instance in the group. |
Response
Success
The 200 status code and the following ClusterInstance status information are returned:
{ "Id": "i-123456789", "Hint": "", "State": "Pending", "IpAddress": "10.160.25.1", "HostName": "hostname", "CreationTime": "2016-01-18T09:15:41.005259Z"}
Attribute description
| Attribute |
Type |
Description |
| Id |
string |
ID of the instance in the cluster |
| Hint |
string |
Hint of the instance. |
| State |
string |
Instance status. The options are Starting, Running, Deleting, and Deleted. |
| IpAddress |
string |
Network address of the instance. |
| HostName |
string |
Hostname for the instance. |
| CreationTime |
string |
Instance creation time. |
| InstancePassword |
string |
Password of the instance. Only visible in the VPC enviroment. |
Error codes
| Error code |
Error message |
Status code |
Syntax |
| InvalidResource.NotFound |
Specified resource is not found. |
404 |
The user requested resource does not exist. |