Oracle Cloud Infrastructure · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Monitoring API
19 actions
19 updates
phrasing
extends
openapi/oracle-cloud-monitoring-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Oracle Cloud Infrastructure's API. It is a proposal applied on top of the contract, not a document Oracle Cloud Infrastructure publishes.
What the actions change
x-apievangelist-phrasing
Targets 19 · first 16 shown; the file carries all of them
$.info
$.paths['/alarmSuppressions'].get
$.paths['/alarmSuppressions'].post
$.paths['/alarmSuppressions/{alarmSuppressionId}'].get
$.paths['/alarmSuppressions/{alarmSuppressionId}'].delete
$.paths['/alarms'].get
$.paths['/alarms'].post
$.paths['/alarms/status'].get
$.paths['/alarms/{alarmId}'].get
$.paths['/alarms/{alarmId}'].put
$.paths['/alarms/{alarmId}'].delete
$.paths['/alarms/{alarmId}/actions/changeCompartment'].post
$.paths['/alarms/{alarmId}/actions/removeSuppression'].post
$.paths['/alarms/{alarmId}/actions/retrieveDimensionStates'].post
$.paths['/alarms/{alarmId}/actions/summarizeAlarmSuppressionHistory'].post
$.paths['/alarms/{alarmId}/history'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Monitoring API
version: 1.0.0
extends: openapi/oracle-cloud-monitoring-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-02'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 18
- target: $.paths['/alarmSuppressions'].get
update:
x-apievangelist-phrasing:
intent: List suppressions on an alarm
effect: read
questions:
- Which suppressions are currently muting notifications for a given alarm?
- Can I filter alarm suppressions by level, like alarm-wide versus dimension-specific?
instructions:
- text: List the suppressions for alarm {alarmId}.
slots:
alarmId: query.alarmId
- text: Show {lifecycleState} alarm suppressions in compartment {compartmentId}.
slots:
lifecycleState: query.lifecycleState
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/alarmSuppressions'].post
update:
x-apievangelist-phrasing:
intent: Suppress an alarm's notifications for a time window
effect: write
questions:
- How do I silence alarm notifications during a planned maintenance window?
- Can I suppress just one dimension of an alarm instead of the whole thing?
instructions:
- text: Suppress target {alarmSuppressionTarget} as {displayName} from {timeSuppressFrom} until {timeSuppressUntil}.
slots:
alarmSuppressionTarget: requestBody.alarmSuppressionTarget
displayName: requestBody.displayName
timeSuppressFrom: requestBody.timeSuppressFrom
timeSuppressUntil: requestBody.timeSuppressUntil
- text: Create suppression {displayName} for target {alarmSuppressionTarget} on dimensions {dimensions}, {timeSuppressFrom} to {timeSuppressUntil}.
slots:
displayName: requestBody.displayName
alarmSuppressionTarget: requestBody.alarmSuppressionTarget
dimensions: requestBody.dimensions
timeSuppressFrom: requestBody.timeSuppressFrom
timeSuppressUntil: requestBody.timeSuppressUntil
method: generated
generated: '2026-09-26'
- target: $.paths['/alarmSuppressions/{alarmSuppressionId}'].get
update:
x-apievangelist-phrasing:
intent: Get the details of one alarm suppression
effect: read
questions:
- When does a particular alarm suppression start and end?
- What dimensions does a specific suppression cover?
instructions:
- text: Show alarm suppression {alarmSuppressionId}.
slots:
alarmSuppressionId: path.alarmSuppressionId
- text: Get the time window of suppression {alarmSuppressionId}.
slots:
alarmSuppressionId: path.alarmSuppressionId
method: generated
generated: '2026-09-26'
- target: $.paths['/alarmSuppressions/{alarmSuppressionId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a specific alarm suppression
effect: destructive
questions:
- How do I end one suppression early by its ID?
- Can I delete one alarm suppression by its suppression ID and keep the alarm's other suppressions?
instructions:
- text: Delete alarm suppression {alarmSuppressionId}.
slots:
alarmSuppressionId: path.alarmSuppressionId
- text: Remove the suppression record {alarmSuppressionId} so notifications resume.
slots:
alarmSuppressionId: path.alarmSuppressionId
method: generated
generated: '2026-10-02'
- target: $.paths['/alarms'].get
update:
x-apievangelist-phrasing:
intent: List the alarms in a compartment
effect: read
questions:
- What monitoring alarms are defined in my compartment?
- Can I include alarms from child compartments in the list?
instructions:
- text: List the alarms in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
- text: Find alarms named {displayName} in compartment {compartmentId}.
slots:
displayName: query.displayName
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/alarms'].post
update:
x-apievangelist-phrasing:
intent: Create a monitoring alarm on a metric query
effect: write
questions:
- How do I get notified when CPU utilization goes above a threshold in Oracle Cloud?
- What severity levels and notification destinations can a new alarm use?
- Can I get a separate notification for each metric stream an alarm watches?
instructions:
- text: Create alarm {displayName} in {compartmentId} on {namespace} query {query}, severity {severity}, notifying {destinations}.
slots:
displayName: requestBody.displayName
compartmentId: requestBody.compartmentId
namespace: requestBody.namespace
query: requestBody.query
severity: requestBody.severity
destinations: requestBody.destinations
- text: Set up an enabled alarm {displayName} watching metrics in compartment {metricCompartmentId} with query {query}.
slots:
displayName: requestBody.displayName
metricCompartmentId: requestBody.metricCompartmentId
query: requestBody.query
method: generated
generated: '2026-09-26'
- target: $.paths['/alarms/status'].get
update:
x-apievangelist-phrasing:
intent: See which alarms are firing in a compartment
effect: read
questions:
- Which of my alarms are currently firing?
- Can I check alarm status for just one resource or service?
instructions:
- text: Show the current status of every alarm in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
- text: List alarms with status {status} in compartment {compartmentId}.
slots:
status: query.status
compartmentId: query.compartmentId
- text: Show alarm statuses for resource {resourceId} in compartment {compartmentId}.
slots:
resourceId: query.resourceId
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}'].get
update:
x-apievangelist-phrasing:
intent: Get the definition of one alarm
effect: read
questions:
- What query, threshold and destinations does a specific alarm use?
- Is a given alarm enabled?
instructions:
- text: Show the configuration of alarm {alarmId}.
slots:
alarmId: path.alarmId
- text: Get the query and severity for alarm {alarmId}.
slots:
alarmId: path.alarmId
method: generated
generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}'].put
update:
x-apievangelist-phrasing:
intent: Change an existing alarm's settings
effect: write
questions:
- Can I change the threshold query on an alarm I already created?
- How do I disable an alarm without deleting it?
instructions:
- text: Change the query of existing alarm {alarmId} to {query}.
slots:
alarmId: path.alarmId
query: requestBody.query
- text: Set isEnabled to {isEnabled} on alarm {alarmId}.
slots:
isEnabled: requestBody.isEnabled
alarmId: path.alarmId
- text: Raise the severity of alarm {alarmId} to {severity}.
slots:
alarmId: path.alarmId
severity: requestBody.severity
method: generated
generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an alarm
effect: destructive
questions:
- How do I permanently remove an alarm I no longer need?
- Can I delete an alarm by its OCID?
instructions:
- text: Delete alarm {alarmId}.
slots:
alarmId: path.alarmId
- text: Permanently remove the monitoring alarm {alarmId}.
slots:
alarmId: path.alarmId
method: generated
generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}/actions/changeCompartment'].post
update:
x-apievangelist-phrasing:
intent: Move an alarm to another compartment
effect: write
questions:
- Can I move an alarm into a different compartment in the same tenancy?
- What's needed to relocate an alarm between compartments?
instructions:
- text: Move alarm {alarmId} to compartment {compartmentId}.
slots:
alarmId: path.alarmId
compartmentId: requestBody.compartmentId
- text: Relocate alarm {alarmId} into compartment {compartmentId}.
slots:
alarmId: path.alarmId
compartmentId: requestBody.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}/actions/removeSuppression'].post
update:
x-apievangelist-phrasing:
intent: Clear every suppression on an alarm
effect: write
questions:
- How do I unmute an alarm and remove all of its suppressions at once?
- Is there a way to lift any existing suppression on a single alarm?
instructions:
- text: Remove all suppressions from alarm {alarmId}.
slots:
alarmId: path.alarmId
- text: Unmute alarm {alarmId} by clearing its suppression.
slots:
alarmId: path.alarmId
method: generated
generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}/actions/retrieveDimensionStates'].post
update:
x-apievangelist-phrasing:
intent: Get the alarm status of each metric stream
effect: read
questions:
- Which specific metric streams or hosts are causing an alarm to fire?
- Can I filter per-stream alarm states by dimension values?
instructions:
- text: Show the status of each metric stream for alarm {alarmId}.
slots:
alarmId: path.alarmId
- text: List metric streams of alarm {alarmId} in status {status} matching dimensions {dimensionFilters}.
slots:
alarmId: path.alarmId
status: requestBody.status
dimensionFilters: requestBody.dimensionFilters
method: generated
generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}/actions/summarizeAlarmSuppressionHistory'].post
update:
x-apievangelist-phrasing:
intent: Get the suppression history of an alarm
effect: read
questions:
- When has this alarm been suppressed in the past?
- Can I see past suppressions of an alarm within a date range?
instructions:
- text: Summarize the suppression history of alarm {alarmId}.
slots:
alarmId: path.alarmId
- text: Show suppressions of alarm {alarmId} that started on or after {timeSuppressFromGreaterThanOrEqualTo}.
slots:
alarmId: path.alarmId
timeSuppressFromGreaterThanOrEqualTo: requestBody.timeSuppressFromGreaterThanOrEqualTo
method: generated
generated: '2026-09-26'
- target: $.paths['/alarms/{alarmId}/history'].get
update:
x-apievangelist-phrasing:
intent: Get the state-change history of an alarm
effect: read
questions:
- When did an alarm last fire and when did it recover?
- Can I pull an alarm's state transitions within a time range?
instructions:
- text: Show the history of alarm {alarmId}.
slots:
alarmId: path.alarmId
- text: Get {alarmHistorytype} history entries for alarm {alarmId} since {timestampGreaterThanOrEqualTo}.
slots:
alarmHistorytype: query.alarmHistorytype
alarmId: path.alarmId
timestampGreaterThanOrEqualTo: query.timestampGreaterThanOrEqualTo
method: generated
generated: '2026-09-26'
- target: $.paths['/metrics'].post
update:
x-apievangelist-phrasing:
intent: Publish custom metric data points
effect: write
questions:
- How do I send my own application metrics into Oracle Cloud Monitoring?
- How far in the past or future can a posted data point's timestamp be?
instructions:
- text: 'Publish these custom metric data points: {metricData}.'
slots:
metricData: requestBody.metricData
- text: Post metric data {metricData} with batch atomicity {batchAtomicity}.
slots:
metricData: requestBody.metricData
batchAtomicity: requestBody.batchAtomicity
method: generated
generated: '2026-09-26'
- target: $.paths['/metrics/actions/listMetrics'].post
update:
x-apievangelist-phrasing:
intent: Find which metric definitions exist
effect: read
questions:
- What metrics are available to query in my compartment?
- Can I list metric names within a single namespace, grouped by dimension?
instructions:
- text: List the metric definitions available in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
- text: Show metric definitions in namespace {namespace} for compartment {compartmentId}.
slots:
namespace: requestBody.namespace
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/metrics/actions/summarizeMetricsData'].post
update:
x-apievangelist-phrasing:
intent: Query aggregated metric values over time
effect: read
questions:
- How do I get average CPU utilization for my instances over the last day?
- Can I choose the resolution when pulling aggregated metric data?
instructions:
- text: Run metric query {query} in namespace {namespace} for compartment {compartmentId}.
slots:
query: requestBody.query
namespace: requestBody.namespace
compartmentId: query.compartmentId
- text: Aggregate {query} from {namespace} in compartment {compartmentId} between {startTime} and {endTime}.
slots:
query: requestBody.query
namespace: requestBody.namespace
compartmentId: query.compartmentId
startTime: requestBody.startTime
endTime: requestBody.endTime
method: generated
generated: '2026-09-26'