Obtains information for a specific “machine”, or more specifically, a specific Coral platform instance that is part of the cluster. The <id> can be formatted as an IP address, a colon and a port (“127.0.0.1:2551”) or as a machine alias (“machine1”). In the case of a machine alias, the machine should have been added to the cluster through the API with that alias. The alias should be unique across the cluster.
Because it is possible to start two instances of Coral on the same machine using different ports, the machine needs to be identified using the IP address and the port combined. Nonetheless, it is questionable how useful it is to divide a fixed amount of resources (a physical computer) across multiple Coral instances.
When successful:
{
"alias": "machine1",
"ip": "127.0.0.1",
"port": 2551,
"roles": [],
"status": "Up"
}The platform returns the alias of the machine (if known, else null), the IP address, the port, possible Akka roles of the machine and its current status.
On failure:
{
"action": "Get machine",
"success": false,
"reason": "Machine with given name not found."
}| status code | description | reason |
|---|---|---|
404 |
Not found | When the combination of IP address and port or the given alias does not match a known machine in the cluster, a 404 error is returned. |