Machines In Cluster

URL:: https://<cluster-url>/machines
Methods:: GET
Version Introduced:: 10.1

Description

This resource lists all the server machines that are currently participating in the cluster. Each server machine listing is accompanied by its status indicating whether the server machine is running or stopped. The list of server machines is dynamic, as machines can be added or removed from the cluster.

Request parameters

Parameter	Details
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

Example usage

Below is a sample request URL for the machines resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/admin/clusters/MapsCluster/machines?f=json

JSON Response syntax

Use dark colors for code blocksCopy
{
  "machines": [
    {
      "configuredState": "<STARTED|STOPPPED>",
      "realTimeState": "<STARTED|STOPPPED>",
      "machineName": "<machine1>"
    },
    {
      "configuredState": "<STARTED|STOPPPED>",
      "realTimeState": "<STARTED|STOPPPED>",
      "machineName": "<machine2>"
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "machines": [
    {
     "configuredState": "STARTED",
     "realTimeState": "STARTED",
     "machineName": "SERVER1.DOMAIN.COM"
    },
    {
     "configuredState": "STOPPPED",
     "realTimeState": "STOPPPED",
     "machineName": "SERVER2.DOMAIN.COM"
    }
  ]
}