Retrieve the cluster status for a target

POST api/v2/jobs/rvc '{"method":"cluster.status","hostnames":["<node_hostname>"]}'

Starts a SC//Reliant™ Virtual Controller (RVC) job to retrieve status details for the cluster a target is a member of. The available targets are a node, node group, or saved filter. The response will indicate that the RVC job is created and is scheduled to run. You can use the job ID from the response to retrieve the job status.

In order to perform this action, the following conditions must be met:

Must have the Remote Job Execution feature turned on at the site level.
The user must have the following capabilities:
- Create and Update a RVC job
- Call Cluster read-only methods

Request syntax

post api/v2/jobs/rvc '{"method":"cluster.status","hostnames":["<node_hostname>"]}'

Request parameters

The request accepts the following data in JSON format.

Parameter	Type	Description	Required
`method`	String	The RVC action to start. This value is specified as a combination of the RVC module and method. For example, to retrieve the cluster status for a target you would specify the `cluster` module and the `status` method combined as `cluster.status`.	Yes
`hostnames`	String array	The list of node hostnames on which to run the RVC job.	Dependent. Only if no node group or saved filter is provided.
`node_group_name`	String	The name of the node group on which to run the RVC job. The RVC job will run on all nodes that are members of the node group.	Dependent. Only if no hostnames or saved filter is provided.
`node_group_id`	Integer	The ID of the node group on which to run the RVC job. The RVC job will run on all nodes that are members of the node group.	Dependent. Only if no hostnames or saved filter is provided.
`saved_filter_name`	String	The name of the saved filter on which to run the RVC job. The RVC job will run on all nodes that match the saved filter.	Dependent. Only if no hostnames or node group is provided.
`saved_filter_id`	Integer	The ID of the saved filter on which to run the RVC job. The RVC job will run on all nodes that match the saved filter.	Dependent. Only if no hostnames or node group is provided.

Response syntax

When the hostnames request parameter is used, the following response syntax is received.

{
    "id": integer,
    "type": "RVC3",
    "status": "string",
    "message": "string",
    "trigged_by": "string",
    "parameters": {
        "method": "cluster.status",
        "hostnames": [
            "string",
            "string"
        ]
    },
    "time_started": "timestamp"
}

When the node group or saved filter request parameters are used, the following response syntax is received.

{
    "id": integer,
    "type": "RVC3",
    "status": "string",
    "message": "string",
    "trigged_by": "string",
    "parameters": {
        "method": "cluster.status",
        "node_group_name": "string",
        "node_group_id": integer,
        "saved_filter_name": "string",
        "saved_filter_id": integer
    },
    "time_started": "timestamp"
}

Response parameters

If the action is successful, an HTTP 200 response is returned. The following data is returned in JSON format.

Field	Type	Description
`id`	Integer	The ID of the RVC job.
`type`	String	The type of RVC job. For RVC jobs, it is `RVC3`.
`status`	String	The status of the job.
`message`	String	This field is reserved for internal use.
`trigged_by`	String	The username of the person who initiated the job.
`parameters`	String	The request parameters indicating the hostnames, Node Groups, or saved filters the RVC job ran on.
`time_started`	Timestamp	The timestamp indicating when the job started. The timestamp is given in ISO 8601 UTC datetime format.

Errors

For a list of potential errors, refer to the common errors, as this action does not have any unique error responses. For more information, see Common errors.

Examples

Example 1: Request the cluster status of one or more nodes using their hostnames.

This example starts an RVC job requesting the cluster status of a node with hostname sit0001red0.

ruby api.rb <customer_code> POST api/v2/jobs/rvc '{"method":"cluster.status","hostnames":["sit0001red0"]}'

Response

{
  "id": 1598481,
  "type": "RVC3",
  "status": "pending",
  "message": null,
  "trigged_by": "test.user",
  "parameters": {
    "method": "cluster.status",
    "hostnames": [
      "sit0001red0"
    ]
  },
  "time_started": "2025-04-09T16:46:13Z"
}

Example 2: Request the cluster status of the nodes in a specified node group.

This example starts an RVC job requesting the cluster status of the nodes in node group Test Node Group.

ruby api.rb <customer_code> POST api/v2/jobs/rvc '{"method":"cluster.status","node_group_name":"Test Node Group"}'

Response

{
  "id": 1596606,
  "type": "RVC3",
  "status": "pending",
  "message": null,
  "trigged_by": "test.user",
  "parameters": {
    "method": "cluster.status",
    "node_group_name": "Test Node Group"
  },
  "time_started": "2025-04-07T19:55:06Z"
}

Example 3: Retrieving the payload from the RVC job.

This example retrieves the payload from RVC job ID 1598689 which displays the payload of the cluster.status method.

ruby api.rb <customer_code> GET api/jobs/1598689\?include_payload=true

Response

{
  "id": 1598689,
  "type": "RVC3",
  "status": "finished",
  "message": null,
  "payload": {
    "sit0001red0": [
      {
        "result": {
          "standby": false,
          "unclean": false,
          "hostname": "sit0001red0",
          "ha_cluster": true,
          "active_node": true,
          "maintenance": false,
          "last_checked": "Thu Apr 10  8:07:43 pm 2025 UTC"
        },
        "timestamp": 1744315663
      }
    ]
  },
  "trigged_by": "test.user",
  "success_nodes_count": 1,
  "failed_nodes_count": 0,
  "total_nodes_count": 1,
  "parameters": {
    "method": "cluster.status",
    "hostnames": [
      "sit0001red0"
    ]
  },
  "time_started": "2025-04-10T20:07:42Z",
  "time_finished": "2025-04-10T20:07:43Z"
}