Instance

A compute instance running in Oracle Cloud Infrastructure.

Cloud ComputingEnterprise CloudInfrastructure as a ServiceOraclePlatform as a Service

Properties

Name Type Description
id string The OCID of the instance.
compartmentId string The OCID of the compartment.
availabilityDomain string The availability domain the instance is running in.
displayName string A user-friendly name.
shape string The shape of the instance.
lifecycleState string The current state of the instance.
region string The region that contains the availability domain.
imageId string The OCID of the image used to boot the instance.
timeCreated string The date and time the instance was created.
freeformTags object Free-form tags for the instance.
definedTags object Defined tags for the instance.
View JSON Schema on GitHub

JSON Schema

compute-instance-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-schema/compute-instance-schema.json",
  "title": "Instance",
  "description": "A compute instance running in Oracle Cloud Infrastructure.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The OCID of the instance.",
      "example": "ocid1.instance.oc1.iad.abcdefg123456"
    },
    "compartmentId": {
      "type": "string",
      "description": "The OCID of the compartment.",
      "example": "ocid1.compartment.oc1..abcdefg123456"
    },
    "availabilityDomain": {
      "type": "string",
      "description": "The availability domain the instance is running in.",
      "example": "Uocm:US-ASHBURN-AD-1"
    },
    "displayName": {
      "type": "string",
      "description": "A user-friendly name.",
      "example": "my-instance-01"
    },
    "shape": {
      "type": "string",
      "description": "The shape of the instance.",
      "example": "VM.Standard.E4.Flex"
    },
    "lifecycleState": {
      "type": "string",
      "description": "The current state of the instance.",
      "enum": "['PROVISIONING', 'RUNNING', 'STARTING', 'STOPPING', 'STOPPED', 'CREATING_IMAGE', 'TERMINATING', 'TERMINATED']",
      "example": "RUNNING"
    },
    "region": {
      "type": "string",
      "description": "The region that contains the availability domain.",
      "example": "us-ashburn-1"
    },
    "imageId": {
      "type": "string",
      "description": "The OCID of the image used to boot the instance.",
      "example": "ocid1.image.oc1.iad.abcdefg123456"
    },
    "timeCreated": {
      "type": "string",
      "description": "The date and time the instance was created.",
      "format": "date-time",
      "example": "2026-01-15T10:30:00Z"
    },
    "freeformTags": {
      "type": "object",
      "description": "Free-form tags for the instance.",
      "example": {
        "key1": "value1"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "definedTags": {
      "type": "object",
      "description": "Defined tags for the instance.",
      "example": {
        "key1": "value1"
      },
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}