MonitoredInstanceCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-monitored-instance-collection-schema.json",
  "title": "MonitoredInstanceCollection",
  "description": "Results of a monitored instance search. Contains MonitoredInstanceSummary items.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-appmgmtcontrol-api-openapi.yml#/components/schemas/MonitoredInstanceCollection",
  "properties": {
    "items": {
      "description": "List of monitored instances.",
      "items": {
        "$ref": "#/$defs/MonitoredInstanceSummary"
      },
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object",
  "x-example": "{\n  items: [\n    {\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      \"monitoringState\": \"ENABLED\",\n      \"lifecycleState\": \"ACTIVE\"\n    }\n  ]\n}\n",
  "$defs": {
    "MonitoredInstanceSummary": {
      "description": "Summary of the monitored instance.",
      "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"
        },
        "lifecycleState": {
          "description": "The current state of the monitored instance.",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/MonitoredInstance/lifecycleState"
        },
        "managementAgentId": {
          "description": "Management Agent Identifier [OCID](/Content/General/Concepts/identifiers.htm).",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "monitoringState": {
          "description": "Monitoring status. Can be either enabled or disabled.",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/MonitoredInstance/monitoringState"
        }
      },
      "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  \"monitoringState\": \"ENABLED\",\n  \"lifecycleState\": \"ACTIVE\"\n}\n"
    }
  }
}