Endpoint

/v2/cluster/object-backed/nodes/dry-run

POST

Validate a node-add, node-remove, or node replacement operation and, if it succeeds, return the projected fault domain counts.

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
200 Return value on success

Schema

{
  "description": "api_cluster_object_backed_modify_dry_run_response",
  "type": "object",
  "properties": {
    "target_membership": {
      "type": "array",
      "items": {
        "description": "The IP addresses and fault domains of the nodes that should be in the cluster after the modification.",
        "type": "object",
        "properties": {
          "node_ip": {
            "description": "node_ip",
            "type": "string"
          },
          "fault_domain_id": {
            "description": "fault_domain_id",
            "type": "number"
          }
        }
      }
    },
    "current_membership": {
      "type": "array",
      "items": {
        "description": "The nodes that are currently in the cluster.",
        "type": "object",
        "properties": {
          "node_id": {
            "description": "node_id",
            "type": "number"
          },
          "node_ip": {
            "description": "node_ip",
            "type": "string"
          },
          "fault_domain_id": {
            "description": "fault_domain_id",
            "type": "number"
          }
        }
      }
    },
    "nodes_being_added": {
      "type": "array",
      "items": {
        "description": "The IP addresses of the nodes that are being added to the cluster during the modification.",
        "type": "object",
        "properties": {
          "node_ip": {
            "description": "node_ip",
            "type": "string"
          },
          "fault_domain_id": {
            "description": "fault_domain_id",
            "type": "number"
          }
        }
      }
    },
    "nodes_being_removed": {
      "type": "array",
      "items": {
        "description": "The nodes that are being removed from the cluster during the modification.",
        "type": "object",
        "properties": {
          "node_id": {
            "description": "node_id",
            "type": "number"
          },
          "node_ip": {
            "description": "node_ip",
            "type": "string"
          },
          "fault_domain_id": {
            "description": "fault_domain_id",
            "type": "number"
          }
        }
      }
    }
  }
}