Endpoint

/v2/cluster/object-backed/nodes

GET

List all object backed nodes in the cluster.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_cluster_object_backed_nodes_get_response",
  "type": "object",
  "properties": {
    "membership": {
      "description": "The list of nodes that are currently in the cluster (ordered by node id).",
      "type": "object",
      "properties": {
        "node_ips_and_fault_domains": {
          "type": "array",
          "items": {
            "description": "The IP addresses and fault domains of the nodes in the cluster.",
            "type": "object",
            "properties": {
              "node_ip": {
                "description": "node_ip",
                "type": "string"
              },
              "fault_domain_id": {
                "description": "fault_domain_id",
                "type": "number"
              }
            }
          }
        }
      }
    }
  }
}

POST

Modify the composition of the object backed cluster by adding unconfigured nodes or replacing configured nodes. Allows for the specification of fault domains on added or replaced nodes.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_cluster_object_backed_nodes_modify_request_v2",
  "type": "object",
  "properties": {
    "target_membership": {
      "description": "The nodes that should be in the cluster after the modification. The nodes that must be added or removed are implicitly derived from the target membership and the current membership of the cluster.",
      "type": "object",
      "properties": {
        "node_ips_and_fault_domains": {
          "type": "array",
          "items": {
            "description": "The IP addresses and fault domains of the nodes in the cluster.",
            "type": "object",
            "properties": {
              "node_ip": {
                "description": "node_ip",
                "type": "string"
              },
              "fault_domain_id": {
                "description": "fault_domain_id",
                "type": "number"
              }
            }
          }
        }
      }
    }
  }
}

Response

Codes

Code Description
202 Return value on success