BdsInstanceSummary

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-bds-instance-summary-schema.json",
  "title": "BdsInstanceSummary",
  "description": "Summary details of the Big Data Service cluster.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-bds-api-openapi.yml#/components/schemas/BdsInstanceSummary",
  "properties": {
    "clusterProfile": {
      "description": "Profile of the Big Data Service cluster.",
      "type": "string",
      "x-obmcs-enumref": "#/definitions/BdsInstance/clusterProfile"
    },
    "clusterVersion": {
      "description": "Version of the Hadoop distribution.",
      "type": "string",
      "x-obmcs-enumref": "#/definitions/BdsInstance/clusterVersion"
    },
    "compartmentId": {
      "description": "The OCID of the compartment.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing predefined tags' keys and values scoped to a namespace.\nFor example, `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor example, `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "The name of the cluster.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Simple key-value pair that is applied without any predefined name, type, or scope.\nExists for cross-compatibility only. For example, `{\"bar-key\": \"value\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "The OCID of the Big Data Service resource.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "isCloudSqlConfigured": {
      "default": false,
      "description": "Boolean flag specifying whether Cloud SQL is configured or not.",
      "type": "boolean"
    },
    "isHighAvailability": {
      "description": "Boolean flag specifying whether or not the cluster is highly available(HA).",
      "type": "boolean"
    },
    "isKafkaConfigured": {
      "default": false,
      "description": "Boolean flag specifying whether Kafka is configured or not.",
      "type": "boolean"
    },
    "isSecure": {
      "description": "Boolean flag specifying whether or not the cluster should be set up as secure.",
      "type": "boolean"
    },
    "lifecycleState": {
      "description": "The state of the cluster.",
      "type": "string",
      "x-obmcs-enumref": "#/definitions/BdsInstance/lifecycleState"
    },
    "numberOfNodes": {
      "description": "The number of nodes that form the cluster.",
      "format": "int32",
      "maximum": 8192,
      "minimum": 1,
      "type": "integer"
    },
    "numberOfNodesRequiringMaintenanceReboot": {
      "description": "Number of nodes that require a maintenance reboot",
      "format": "int32",
      "maximum": 8192,
      "minimum": 1,
      "type": "integer"
    },
    "timeCreated": {
      "description": "The time the cluster was created, shown as an RFC 3339 formatted datetime string.",
      "format": "date-time",
      "type": "string"
    },
    "timeEarliestCertificateExpiration": {
      "description": "The earliest time of certificate expiration date across the certificates of all current nodes under this cluster.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "compartmentId",
    "displayName",
    "lifecycleState",
    "isCloudSqlConfigured",
    "isKafkaConfigured",
    "numberOfNodes",
    "isHighAvailability",
    "isSecure",
    "timeCreated"
  ],
  "type": "object"
}