Endpoint

/v4/cluster/object-backed/create

POST

Form an object backed cluster with the given set of node IPs, fault domain IDs, object storage URIs and admin password.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_cluster_creation_object_backed_request_v4",
  "type": "object",
  "properties": {
    "eula_accepted": {
      "description": "User accepts the End User License Agreement",
      "type": "boolean"
    },
    "cluster_name": {
      "description": "Name of the cluster",
      "type": "string"
    },
    "node_ips_and_fault_domains": {
      "type": "array",
      "items": {
        "description": "List of node IP and their respective fault domains to form a cluster with",
        "type": "object",
        "properties": {
          "node_ip": {
            "description": "node_ip",
            "type": "string"
          },
          "fault_domain_id": {
            "description": "fault_domain_id",
            "type": "number"
          }
        }
      }
    },
    "admin_password": {
      "description": "The administrator password",
      "type": "string",
      "format": "password"
    },
    "host_instance_id": {
      "description": "EC2 instance ID for the node handling this request",
      "type": "string"
    },
    "azure_key_vault": {
      "description": "The key vault for accessing Azure blobs (only used on Azure clusters).",
      "type": "string"
    },
    "object_storage_uris": {
      "type": "array",
      "items": {
        "description": "The URI to the object storage that backs the Object Tier for the cluster",
        "type": "string"
      }
    },
    "usable_capacity_clamp": {
      "description": "Usable capacity, in bytes, to clamp the file system to",
      "type": "string"
    },
    "product_type": {
      "type": "string",
      "enum": [
        "ACTIVE_WITH_STANDARD_STORAGE",
        "ACTIVE_WITH_INTELLIGENT_STORAGE",
        "ACTIVE_WITH_HOT_STORAGE",
        "ARCHIVE_WITH_IA_STORAGE",
        "ARCHIVE_WITH_GIR_STORAGE",
        "ARCHIVE_WITH_COLD_STORAGE"
      ],
      "description": "The product type of cluster to create. Valid options for AWS clusters are:ACTIVE_WITH_STANDARD_STORAGE, ACTIVE_WITH_INTELLIGENT_STORAGE, ARCHIVE_WITH_IA_STORAGE, ARCHIVE_WITH_GIR_STORAGE. Valid options for Azureclusters are: ACTIVE_WITH_HOT_STORAGE, ARCHIVE_WITH_COLD_STORAGE.:\n * `ACTIVE_WITH_HOT_STORAGE` - ACTIVE_WITH_HOT_STORAGE,\n * `ACTIVE_WITH_INTELLIGENT_STORAGE` - ACTIVE_WITH_INTELLIGENT_STORAGE,\n * `ACTIVE_WITH_STANDARD_STORAGE` - ACTIVE_WITH_STANDARD_STORAGE,\n * `ARCHIVE_WITH_COLD_STORAGE` - ARCHIVE_WITH_COLD_STORAGE,\n * `ARCHIVE_WITH_GIR_STORAGE` - ARCHIVE_WITH_GIR_STORAGE,\n * `ARCHIVE_WITH_IA_STORAGE` - ARCHIVE_WITH_IA_STORAGE"
    },
    "pbkdf2_admin_hash": {
      "description": "The PBKDF2 has parameters for the administrative user: a hexadecimal hash, a hexadecimal salt, and the number of iterations. It is possible to use these parameters for administrative password or a different password.",
      "type": "object",
      "properties": {
        "hash": {
          "type": "array",
          "items": {
            "description": "hash",
            "type": "number"
          }
        },
        "salt": {
          "type": "array",
          "items": {
            "description": "salt",
            "type": "number"
          }
        },
        "num_iterations": {
          "description": "num_iterations",
          "type": "number"
        }
      }
    },
    "operator_public_keys": {
      "type": "array",
      "items": {
        "description": "The set of public keys allowed to sign operator bearer tokens",
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "description": "data",
              "type": "number"
            }
          }
        }
      }
    }
  }
}

Response

Codes

Code Description
202 Return value on success