Oracle · Schema

Instance

A compute instance is a virtual machine (VM) or bare metal host running in Oracle Cloud Infrastructure. It includes information about the shape, image, networking, and lifecycle state.

CloudDatabaseEnterpriseInfrastructureSaaSFortune 100

Properties

Name Type Description
id string The OCID of the instance
compartmentId string The OCID of the compartment containing the instance
availabilityDomain string The availability domain the instance is running in (e.g., Uocm:PHX-AD-1)
faultDomain string The fault domain the instance is running in. A fault domain is a grouping of hardware and infrastructure within an availability domain.
displayName string A user-friendly name. Does not have to be unique, and it is changeable. Avoid entering confidential information.
shape string The shape of the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated.
region string The region that contains the availability domain the instance is running in
imageId string Deprecated. Use sourceDetails instead. The OCID of the image used to boot the instance.
timeCreated string The date and time the instance was created, in the format defined by RFC 3339.
metadata object Custom metadata key/value pairs. The metadata can include ssh_authorized_keys and user_data for cloud-init.
extendedMetadata object Additional metadata key/value pairs that can contain nested JSON objects.
launchMode string Specifies the configuration mode for launching VM instances.
timeMaintenanceRebootDue string The date and time the instance is expected to be stopped or migrated for infrastructure maintenance, if applicable.
capacityReservationId string The OCID of the compute capacity reservation this instance is launched under, if applicable.
dedicatedVmHostId string The OCID of the dedicated virtual machine host that the instance is placed on, if applicable.
isCrossNumaNode boolean Whether the instance spans multiple NUMA nodes
View JSON Schema on GitHub

JSON Schema

oci-compute-instance-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Instance",
  "type": "object",
  "description": "A compute instance is a virtual machine (VM) or bare metal host running in Oracle Cloud Infrastructure. It includes information about the shape, image, networking, and lifecycle state.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The OCID of the instance"
    },
    "compartmentId": {
      "type": "string",
      "description": "The OCID of the compartment containing the instance"
    },
    "availabilityDomain": {
      "type": "string",
      "description": "The availability domain the instance is running in (e.g., Uocm:PHX-AD-1)"
    },
    "faultDomain": {
      "type": "string",
      "description": "The fault domain the instance is running in. A fault domain is a grouping of hardware and infrastructure within an availability domain."
    },
    "displayName": {
      "type": "string",
      "description": "A user-friendly name. Does not have to be unique, and it is changeable. Avoid entering confidential information."
    },
    "shape": {
      "type": "string",
      "description": "The shape of the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated."
    },
    "region": {
      "type": "string",
      "description": "The region that contains the availability domain the instance is running in"
    },
    "imageId": {
      "type": "string",
      "description": "Deprecated. Use sourceDetails instead. The OCID of the image used to boot the instance."
    },
    "timeCreated": {
      "type": "string",
      "description": "The date and time the instance was created, in the format defined by RFC 3339."
    },
    "metadata": {
      "type": "object",
      "description": "Custom metadata key/value pairs. The metadata can include ssh_authorized_keys and user_data for cloud-init."
    },
    "extendedMetadata": {
      "type": "object",
      "description": "Additional metadata key/value pairs that can contain nested JSON objects."
    },
    "launchMode": {
      "type": "string",
      "description": "Specifies the configuration mode for launching VM instances."
    },
    "timeMaintenanceRebootDue": {
      "type": "string",
      "description": "The date and time the instance is expected to be stopped or migrated for infrastructure maintenance, if applicable."
    },
    "capacityReservationId": {
      "type": "string",
      "description": "The OCID of the compute capacity reservation this instance is launched under, if applicable."
    },
    "dedicatedVmHostId": {
      "type": "string",
      "description": "The OCID of the dedicated virtual machine host that the instance is placed on, if applicable."
    },
    "isCrossNumaNode": {
      "type": "boolean",
      "description": "Whether the instance spans multiple NUMA nodes"
    }
  }
}