Alarm

A monitoring alarm.

Cloud ComputingEnterprise CloudInfrastructure as a ServiceOraclePlatform as a Service

Properties

Name	Type	Description
id	string
compartmentId	string
displayName	string
metricCompartmentId	string
namespace	string
query	string
severity	string
isEnabled	boolean
lifecycleState	string
destinations	array
timeCreated	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Alarm",
  "title": "Alarm",
  "type": "object",
  "description": "A monitoring alarm.",
  "properties": {
    "id": {
      "type": "string",
      "example": "ocid1.alarm.oc1.iad.abcdefg123456"
    },
    "compartmentId": {
      "type": "string",
      "example": "ocid1.resource.oc1.iad.abcdefg123456"
    },
    "displayName": {
      "type": "string",
      "example": "High CPU Alarm"
    },
    "metricCompartmentId": {
      "type": "string",
      "example": "ocid1.resource.oc1.iad.abcdefg123456"
    },
    "namespace": {
      "type": "string",
      "example": "oci_computeagent"
    },
    "query": {
      "type": "string",
      "example": "CpuUtilization[1m].mean() > 90"
    },
    "severity": {
      "type": "string",
      "enum": [
        "CRITICAL",
        "ERROR",
        "WARNING",
        "INFO"
      ],
      "example": "CRITICAL"
    },
    "isEnabled": {
      "type": "boolean",
      "example": true
    },
    "lifecycleState": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "DELETING",
        "DELETED"
      ],
      "example": "ACTIVE"
    },
    "destinations": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "example-value"
      ]
    },
    "timeCreated": {
      "type": "string",
      "format": "date-time",
      "example": "2026-04-18T10:30:00Z"
    }
  }
}