MonitoredInstance

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-monitored-instance-schema.json",
  "title": "MonitoredInstance",
  "description": "Description of Monitored Instance.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-appmgmtcontrol-api-openapi.yml#/components/schemas/MonitoredInstance",
  "properties": {
    "compartmentId": {
      "description": "Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm)",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "displayName": {
      "description": "A user-friendly name of the monitored instance. It is binded to [Compute Instance](/Content/Compute/Concepts/computeoverview.htm).\nDisplayName is fetched from [Core Service API](/api/#/en/iaas/20160918/Instance/).\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "instanceId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of monitored instance.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "lifecycleDetails": {
      "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of the monitored instance.",
      "enum": [
        "CREATING",
        "UPDATING",
        "ACTIVE",
        "INACTIVE",
        "DELETING",
        "DELETED",
        "FAILED"
      ],
      "type": "string"
    },
    "managementAgentId": {
      "description": "Management Agent Identifier [OCID](/Content/General/Concepts/identifiers.htm).\nUsed to invoke manage operations on Management Agent Cloud Service.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "monitoringState": {
      "default": "DISABLED",
      "description": "Monitoring status. Can be either enabled or disabled.",
      "enum": [
        "ENABLED",
        "DISABLED"
      ],
      "type": "string"
    },
    "timeCreated": {
      "description": "The time the MonitoredInstance was created. An RFC3339 formatted datetime string",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The time the MonitoredInstance was updated. An RFC3339 formatted datetime string",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "instanceId",
    "compartmentId"
  ],
  "type": "object",
  "x-example": "{\n  \"instanceId\": \"ocid1.instance.oc1.iad.<unique_id>\",\n  \"compartmentId\": \"ocid1.comapertment.oc1..<unique_id>\",\n  \"displayName\": \"someDisplayName\",\n  \"managementAgentId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n  \"timeCreated\": \"2021-10-27T17:05:50.347+0200\",\n  \"timeUpdated\": \"2021-11-29T13:22:57.729+0100\",\n  \"monitoringState\": \"ENABLED\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"lifecycleDetails: \"\"\n}\n"
}