Lists the current alarm status of each metric stream, where status is derived from the metric stream’s last associated transition. Optionally filter by status value and one or more dimension key-value pairs. For more information, see Listing Metric Stream Status in an Alarm.

For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.


oci monitoring alarm-dimension-states-collection retrieve-dimension-states [OPTIONS]

Required Parameters

--alarm-id [text]

The OCID of an alarm.

Optional Parameters

--dimension-filters [complex type]

A filter to return only alarm state entries that match the exact set of specified dimension key-value pairs. If you specify “availabilityDomain”: “phx-ad-1” but the alarm state entry corresponds to the set “availabilityDomain”: “phx-ad-1” and “resourceId”: “ocid1.instance.region1.phx.exampleuniqueID”, then no results are returned. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link:

--limit [integer]

For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

Default: 1000


--page [text]

For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

--status [text]

A filter to return only alarm state entries that match the status value. Example: FIRING

Example using required parameter

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci monitoring alarm create --generate-param-json-input destinations > destinations.json

Copy the following CLI commands into a file named Run the command by typing “bash” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> #
    export display_name=<substitute-value-of-display_name> #
    export is_enabled=<substitute-value-of-is_enabled> #
    export metric_compartment_id=<substitute-value-of-metric_compartment_id> #
    export namespace=<substitute-value-of-namespace> #
    export query_text=<substitute-value-of-query_text> #
    export severity=<substitute-value-of-severity> #

    alarm_id=$(oci monitoring alarm create --compartment-id $compartment_id --destinations file://destinations.json --display-name $display_name --is-enabled $is_enabled --metric-compartment-id $metric_compartment_id --namespace $namespace --query-text $query_text --severity $severity --query --raw-output)

    oci monitoring alarm-dimension-states-collection retrieve-dimension-states --alarm-id $alarm_id