Oracle Cloud Infrastructure · JSON Structure

Monitoring Create Alarm Details Structure

CreateAlarmDetails schema from oracle-cloud-monitoring-openapi.yaml

Type: object Properties: 8 Required: 8
Cloud ComputingEnterprise CloudInfrastructure as a ServiceOraclePlatform as a Service

CreateAlarmDetails is a JSON Structure definition published by Oracle Cloud Infrastructure, describing 8 properties, of which 8 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

compartmentId displayName metricCompartmentId namespace query severity isEnabled destinations

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-structure/monitoring-create-alarm-details-structure.json",
  "name": "CreateAlarmDetails",
  "description": "CreateAlarmDetails schema from oracle-cloud-monitoring-openapi.yaml",
  "type": "object",
  "properties": {
    "compartmentId": {
      "type": "string",
      "example": "ocid1.resource.oc1.iad.abcdefg123456"
    },
    "displayName": {
      "type": "string",
      "example": "my-resource"
    },
    "metricCompartmentId": {
      "type": "string",
      "example": "ocid1.resource.oc1.iad.abcdefg123456"
    },
    "namespace": {
      "type": "string",
      "example": "oci_computeagent"
    },
    "query": {
      "type": "string",
      "example": "CpuUtilization[1m].mean()"
    },
    "severity": {
      "type": "string",
      "enum": "['CRITICAL', 'ERROR', 'WARNING', 'INFO']",
      "example": "CRITICAL"
    },
    "isEnabled": {
      "type": "boolean",
      "example": true
    },
    "destinations": {
      "type": "array",
      "example": "['example-value']",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "compartmentId",
    "displayName",
    "metricCompartmentId",
    "namespace",
    "query",
    "severity",
    "isEnabled",
    "destinations"
  ]
}