Cluster

A Kubernetes cluster managed by OKE.

Cloud ComputingEnterprise CloudInfrastructure as a ServiceOraclePlatform as a Service

Properties

Name	Type	Description
id	string	The OCID of the cluster.
compartmentId	string
name	string
kubernetesVersion	string
vcnId	string
lifecycleState	string
endpoints	object
timeCreated	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Cluster",
  "title": "Cluster",
  "type": "object",
  "description": "A Kubernetes cluster managed by OKE.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The OCID of the cluster.",
      "example": "ocid1.cluster.oc1.iad.abcdefg123456"
    },
    "compartmentId": {
      "type": "string",
      "example": "ocid1.resource.oc1.iad.abcdefg123456"
    },
    "name": {
      "type": "string",
      "example": "my-cluster"
    },
    "kubernetesVersion": {
      "type": "string",
      "example": "v1.28.2"
    },
    "vcnId": {
      "type": "string",
      "example": "ocid1.resource.oc1.iad.abcdefg123456"
    },
    "lifecycleState": {
      "type": "string",
      "enum": [
        "CREATING",
        "ACTIVE",
        "FAILED",
        "DELETING",
        "DELETED",
        "UPDATING"
      ],
      "example": "CREATING"
    },
    "endpoints": {
      "type": "object",
      "properties": {
        "kubernetes": {
          "type": "string"
        },
        "publicEndpoint": {
          "type": "string"
        },
        "privateEndpoint": {
          "type": "string"
        }
      },
      "example": {
        "kubernetes": "example-value",
        "publicEndpoint": "example-value",
        "privateEndpoint": "example-value"
      }
    },
    "timeCreated": {
      "type": "string",
      "format": "date-time",
      "example": "2026-04-18T10:30:00Z"
    }
  }
}