ClusterCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-cluster-collection-schema.json",
  "title": "ClusterCollection",
  "description": "A list of Clusters.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-cluster-api-openapi.yml#/components/schemas/ClusterCollection",
  "properties": {
    "items": {
      "description": "A list of Clusters.",
      "items": {
        "$ref": "#/$defs/ClusterSummary"
      },
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object",
  "$defs": {
    "ClusterByolAllocationDetails": {
      "description": "The BYOL allocations used for VMware Cluster provisioning.\n",
      "properties": {
        "firewallByolAllocationId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "vsanByolAllocationId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "type": "object"
    },
    "ClusterSummary": {
      "description": "A summary of the Cluster.",
      "properties": {
        "clusterByolAllocationDetails": {
          "$ref": "#/$defs/ClusterByolAllocationDetails"
        },
        "compartmentId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that\ncontains the Cluster.\n",
          "type": "string"
        },
        "computeAvailabilityDomain": {
          "description": "The availability domain that the Cluster's ESXi hosts are running in. For Multi-AD Cluster, it is `multi-AD`.\n",
          "type": "string"
        },
        "definedTags": {
          "additionalProperties": {
            "additionalProperties": {
              "description": "The value of the tag. Only the String type is supported.\n",
              "type": "object"
            },
            "description": "Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
            "type": "object"
          },
          "description": "Defined tags for this resource. Each key is predefined and scoped to a\nnamespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
          "type": "object"
        },
        "displayName": {
          "description": "A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits,\nwhitespaces, dashes and underscores.\nAvoid entering confidential information.\n",
          "type": "string"
        },
        "esxiHostsCount": {
          "description": "The number of ESXi hosts in the Cluster.",
          "type": "integer"
        },
        "freeformTags": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no\npredefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
          "type": "object"
        },
        "id": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that\ncontains the Cluster.\n",
          "type": "string"
        },
        "initialHostOcpuCount": {
          "description": "The initial OCPU count of the Cluster's ESXi hosts.\n",
          "format": "float",
          "minimum": 0,
          "type": "number"
        },
        "initialHostShapeName": {
          "description": "The initial compute shape of the Cluster's ESXi hosts.\n[ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).\n",
          "type": "string"
        },
        "isShieldedInstanceEnabled": {
          "default": false,
          "description": "Indicates whether shielded instance is enabled at the Cluster level.\n",
          "type": "boolean"
        },
        "lifecycleState": {
          "description": "The current state of the Cluster.",
          "enum": [
            "CREATING",
            "UPDATING",
            "ACTIVE",
            "DELETING",
            "DELETED",
            "FAILED"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/LifecycleStates"
        },
        "sddcId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC that the\nCluster belongs to.\n",
          "type": "string"
        },
        "systemTags": {
          "additionalProperties": {
            "additionalProperties": {
              "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
              "type": "object"
            },
            "description": "Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type": "object"
          },
          "description": "Usage of system tag keys. These predefined keys are scoped to namespaces.\nExample: `{orcl-cloud: {free-tier-retain: true}}`\n",
          "type": "object"
        },
        "timeCreated": {
          "description": "The date and time the Cluster was created, in the format defined by\n[RFC3339](https://tools.ietf.org/html/rfc3339).\n\nExample: `2016-08-25T21:10:29.600Z`\n",
          "format": "date-time",
          "type": "string"
        },
        "timeUpdated": {
          "description": "The date and time the Cluster was updated, in the format defined by\n[RFC3339](https://tools.ietf.org/html/rfc3339).\n",
          "format": "date-time",
          "type": "string"
        },
        "vmwareSoftwareVersion": {
          "description": "In general, this is a specific version of bundled VMware software supported by\nOracle Cloud VMware Solution (see\n[ListSupportedVmwareSoftwareVersions](#/en/vmware/20200501/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions)).\n\nThis attribute is not guaranteed to reflect the version of\nsoftware currently installed on the ESXi hosts in the Cluster. The purpose\nof this attribute is to show the version of software that the Oracle\nCloud VMware Solution will install on any new ESXi hosts that you *add to this\nCluster in the future* with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).\n\nTherefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer\nversion of bundled VMware software supported by the Oracle Cloud VMware Solution, you\nshould use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's\n`vmwareSoftwareVersion` with that new version.\n",
          "type": "string"
        },
        "vsphereType": {
          "description": "vSphere Cluster types.\n",
          "enum": [
            "MANAGEMENT",
            "WORKLOAD"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/VsphereTypes"
        }
      },
      "required": [
        "id",
        "computeAvailabilityDomain",
        "compartmentId",
        "sddcId",
        "displayName",
        "esxiHostsCount",
        "vmwareSoftwareVersion",
        "freeformTags",
        "definedTags",
        "initialHostShapeName",
        "vsphereType"
      ],
      "type": "object"
    }
  }
}