Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.Monitoring.getAlarms

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAlarms = oci.Monitoring.getAlarms({
    compartmentId: compartmentId,
    compartmentIdInSubtree: alarmCompartmentIdInSubtree,
    displayName: alarmDisplayName,
    state: alarmState,
});

import pulumi
import pulumi_oci as oci

test_alarms = oci.Monitoring.get_alarms(compartment_id=compartment_id,
    compartment_id_in_subtree=alarm_compartment_id_in_subtree,
    display_name=alarm_display_name,
    state=alarm_state)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Monitoring"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Monitoring.GetAlarms(ctx, &monitoring.GetAlarmsArgs{
			CompartmentId:          compartmentId,
			CompartmentIdInSubtree: pulumi.BoolRef(alarmCompartmentIdInSubtree),
			DisplayName:            pulumi.StringRef(alarmDisplayName),
			State:                  pulumi.StringRef(alarmState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testAlarms = Oci.Monitoring.GetAlarms.Invoke(new()
    {
        CompartmentId = compartmentId,
        CompartmentIdInSubtree = alarmCompartmentIdInSubtree,
        DisplayName = alarmDisplayName,
        State = alarmState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Monitoring.MonitoringFunctions;
import com.pulumi.oci.Monitoring.inputs.GetAlarmsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testAlarms = MonitoringFunctions.getAlarms(GetAlarmsArgs.builder()
            .compartmentId(compartmentId)
            .compartmentIdInSubtree(alarmCompartmentIdInSubtree)
            .displayName(alarmDisplayName)
            .state(alarmState)
            .build());

    }
}

variables:
  testAlarms:
    fn::invoke:
      Function: oci:Monitoring:getAlarms
      Arguments:
        compartmentId: ${compartmentId}
        compartmentIdInSubtree: ${alarmCompartmentIdInSubtree}
        displayName: ${alarmDisplayName}
        state: ${alarmState}

Using getAlarms

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAlarms(args: GetAlarmsArgs, opts?: InvokeOptions): Promise<GetAlarmsResult>
function getAlarmsOutput(args: GetAlarmsOutputArgs, opts?: InvokeOptions): Output<GetAlarmsResult>

def get_alarms(compartment_id: Optional[str] = None,
               compartment_id_in_subtree: Optional[bool] = None,
               display_name: Optional[str] = None,
               filters: Optional[Sequence[_monitoring.GetAlarmsFilter]] = None,
               state: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetAlarmsResult
def get_alarms_output(compartment_id: Optional[pulumi.Input[str]] = None,
               compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
               display_name: Optional[pulumi.Input[str]] = None,
               filters: Optional[pulumi.Input[Sequence[pulumi.Input[_monitoring.GetAlarmsFilterArgs]]]] = None,
               state: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetAlarmsResult]

func GetAlarms(ctx *Context, args *GetAlarmsArgs, opts ...InvokeOption) (*GetAlarmsResult, error)
func GetAlarmsOutput(ctx *Context, args *GetAlarmsOutputArgs, opts ...InvokeOption) GetAlarmsResultOutput

> Note: This function is named GetAlarms in the Go SDK.

public static class GetAlarms 
{
    public static Task<GetAlarmsResult> InvokeAsync(GetAlarmsArgs args, InvokeOptions? opts = null)
    public static Output<GetAlarmsResult> Invoke(GetAlarmsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAlarmsResult> getAlarms(GetAlarmsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Monitoring/getAlarms:getAlarms
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID
CompartmentIdInSubtree bool: When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
DisplayName string: A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
Filters List<GetAlarmsFilter>
State string: A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

CompartmentId string: The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID
CompartmentIdInSubtree bool: When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
DisplayName string: A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
Filters []GetAlarmsFilter
State string: A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

compartmentId String: The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID
compartmentIdInSubtree Boolean: When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
displayName String: A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
filters List<GetAlarmsFilter>
state String: A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

compartmentId string: The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID
compartmentIdInSubtree boolean: When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
displayName string: A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
filters GetAlarmsFilter[]
state string: A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

compartment_id str: The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID
compartment_id_in_subtree bool: When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
display_name str: A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
filters Sequence[monitoring.GetAlarmsFilter]
state str: A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

compartmentId String: The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID
compartmentIdInSubtree Boolean: When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
displayName String: A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
filters List<Property Map>
state String: A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

getAlarms Result

The following output properties are available:

Alarms List<GetAlarmsAlarm>: The list of alarms.
CompartmentId string: The OCID of the compartment containing the alarm.
Id string: The provider-assigned unique ID for this managed resource.
CompartmentIdInSubtree bool
DisplayName string: A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
Filters List<GetAlarmsFilter>
State string: The current lifecycle state of the alarm. Example: DELETED

Alarms []GetAlarmsAlarm: The list of alarms.
CompartmentId string: The OCID of the compartment containing the alarm.
Id string: The provider-assigned unique ID for this managed resource.
CompartmentIdInSubtree bool
DisplayName string: A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
Filters []GetAlarmsFilter
State string: The current lifecycle state of the alarm. Example: DELETED

alarms List<GetAlarmsAlarm>: The list of alarms.
compartmentId String: The OCID of the compartment containing the alarm.
id String: The provider-assigned unique ID for this managed resource.
compartmentIdInSubtree Boolean
displayName String: A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
filters List<GetAlarmsFilter>
state String: The current lifecycle state of the alarm. Example: DELETED

alarms GetAlarmsAlarm[]: The list of alarms.
compartmentId string: The OCID of the compartment containing the alarm.
id string: The provider-assigned unique ID for this managed resource.
compartmentIdInSubtree boolean
displayName string: A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
filters GetAlarmsFilter[]
state string: The current lifecycle state of the alarm. Example: DELETED

alarms Sequence[monitoring.GetAlarmsAlarm]: The list of alarms.
compartment_id str: The OCID of the compartment containing the alarm.
id str: The provider-assigned unique ID for this managed resource.
compartment_id_in_subtree bool
display_name str: A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
filters Sequence[monitoring.GetAlarmsFilter]
state str: The current lifecycle state of the alarm. Example: DELETED

alarms List<Property Map>: The list of alarms.
compartmentId String: The OCID of the compartment containing the alarm.
id String: The provider-assigned unique ID for this managed resource.
compartmentIdInSubtree Boolean
displayName String: A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
filters List<Property Map>
state String: The current lifecycle state of the alarm. Example: DELETED

Supporting Types

GetAlarmsAlarm

AlarmSummary string

Customizable alarm summary (alarmSummary alarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to ListAlarmStatus GetAlarmHistory and RetrieveDimensionStates.

Body string

The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.

CompartmentId string

The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID

DefinedTags Dictionary<string, string>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}

Destinations List<string>

A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a topic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.

DisplayName string

A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.

EvaluationSlackDuration string

Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.

FreeformTags Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

Id string

The OCID of the alarm.

IsEnabled bool

Whether the alarm is enabled. Example: true

IsNotificationsPerMetricDimensionEnabled bool

Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true

MessageFormat string

The format to use for alarm notifications. The formats are:

RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format.
PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only.
ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only.

MetricCompartmentId string

The OCID of the compartment containing the metric being evaluated by the alarm.

MetricCompartmentIdInSubtree bool

When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: true

Namespace string

The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent

NotificationTitle string

Customizable notification title (title alarm message parameter). Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.

NotificationVersion string

The version of the alarm notification to be delivered. Allowed value: 1.X The value must start with a number (up to four digits), followed by a period and an uppercase X.

Overrides List<GetAlarmsAlarmOverride>

A set of overrides that control evaluations of the alarm.

PendingDuration string

The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".

Query string

The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.

RepeatNotificationDuration string

The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum: PT1M. Maximum: P30D.

Resolution string

The time between calculated aggregation windows for the alarm. Supported value: 1m

ResourceGroup string

Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: frontend-fleet

RuleName string

Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.

Severity string

The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

State string

A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

Suppressions List<GetAlarmsAlarmSuppression>

The configuration details for suppressing an alarm.

TimeCreated string

The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z

TimeUpdated string

The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z

AlarmSummary string

Body string

CompartmentId string

DefinedTags map[string]string

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}

Destinations []string

DisplayName string

A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.

EvaluationSlackDuration string

FreeformTags map[string]string

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

Id string

The OCID of the alarm.

IsEnabled bool

Whether the alarm is enabled. Example: true

IsNotificationsPerMetricDimensionEnabled bool

Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true

MessageFormat string

The format to use for alarm notifications. The formats are:

RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format.
PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only.
ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only.

MetricCompartmentId string

The OCID of the compartment containing the metric being evaluated by the alarm.

MetricCompartmentIdInSubtree bool

Namespace string

The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent

NotificationTitle string

NotificationVersion string

The version of the alarm notification to be delivered. Allowed value: 1.X The value must start with a number (up to four digits), followed by a period and an uppercase X.

Overrides []GetAlarmsAlarmOverride

A set of overrides that control evaluations of the alarm.

PendingDuration string

Query string

RepeatNotificationDuration string

Resolution string

The time between calculated aggregation windows for the alarm. Supported value: 1m

ResourceGroup string

RuleName string

Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.

Severity string

The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

State string

A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

Suppressions []GetAlarmsAlarmSuppression

The configuration details for suppressing an alarm.

TimeCreated string

The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z

TimeUpdated string

The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z

alarmSummary String

body String

compartmentId String

definedTags Map<String,String>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}

destinations List<String>

displayName String

A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.

evaluationSlackDuration String

freeformTags Map<String,String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

id String

The OCID of the alarm.

isEnabled Boolean

Whether the alarm is enabled. Example: true

isNotificationsPerMetricDimensionEnabled Boolean

Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true

messageFormat String

The format to use for alarm notifications. The formats are:

RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format.
PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only.
ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only.

metricCompartmentId String

The OCID of the compartment containing the metric being evaluated by the alarm.

metricCompartmentIdInSubtree Boolean

namespace String

The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent

notificationTitle String

notificationVersion String

The version of the alarm notification to be delivered. Allowed value: 1.X The value must start with a number (up to four digits), followed by a period and an uppercase X.

overrides List<GetAlarmsAlarmOverride>

A set of overrides that control evaluations of the alarm.

pendingDuration String

query String

repeatNotificationDuration String

resolution String

The time between calculated aggregation windows for the alarm. Supported value: 1m

resourceGroup String

ruleName String

Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.

severity String

The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

state String

A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

suppressions List<GetAlarmsAlarmSuppression>

The configuration details for suppressing an alarm.

timeCreated String

The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z

timeUpdated String

The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z

alarmSummary string

body string

compartmentId string

definedTags {[key: string]: string}

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}

destinations string[]

displayName string

A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.

evaluationSlackDuration string

freeformTags {[key: string]: string}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

id string

The OCID of the alarm.

isEnabled boolean

Whether the alarm is enabled. Example: true

isNotificationsPerMetricDimensionEnabled boolean

Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true

messageFormat string

The format to use for alarm notifications. The formats are:

RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format.
PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only.
ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only.

metricCompartmentId string

The OCID of the compartment containing the metric being evaluated by the alarm.

metricCompartmentIdInSubtree boolean

namespace string

The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent

notificationTitle string

notificationVersion string

The version of the alarm notification to be delivered. Allowed value: 1.X The value must start with a number (up to four digits), followed by a period and an uppercase X.

overrides GetAlarmsAlarmOverride[]

A set of overrides that control evaluations of the alarm.

pendingDuration string

query string

repeatNotificationDuration string

resolution string

The time between calculated aggregation windows for the alarm. Supported value: 1m

resourceGroup string

ruleName string

Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.

severity string

The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

state string

A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

suppressions GetAlarmsAlarmSuppression[]

The configuration details for suppressing an alarm.

timeCreated string

The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z

timeUpdated string

The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z

alarm_summary str

body str

compartment_id str

defined_tags Mapping[str, str]

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}

destinations Sequence[str]

display_name str

A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.

evaluation_slack_duration str

freeform_tags Mapping[str, str]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

id str

The OCID of the alarm.

is_enabled bool

Whether the alarm is enabled. Example: true

is_notifications_per_metric_dimension_enabled bool

Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true

message_format str

The format to use for alarm notifications. The formats are:

RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format.
PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only.
ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only.

metric_compartment_id str

The OCID of the compartment containing the metric being evaluated by the alarm.

metric_compartment_id_in_subtree bool

namespace str

The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent

notification_title str

notification_version str

The version of the alarm notification to be delivered. Allowed value: 1.X The value must start with a number (up to four digits), followed by a period and an uppercase X.

overrides Sequence[monitoring.GetAlarmsAlarmOverride]

A set of overrides that control evaluations of the alarm.

pending_duration str

query str

repeat_notification_duration str

resolution str

The time between calculated aggregation windows for the alarm. Supported value: 1m

resource_group str

rule_name str

Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.

severity str

The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

state str

A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

suppressions Sequence[monitoring.GetAlarmsAlarmSuppression]

The configuration details for suppressing an alarm.

time_created str

The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z

time_updated str

The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z

alarmSummary String

body String

compartmentId String

definedTags Map<String>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}

destinations List<String>

displayName String

A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.

evaluationSlackDuration String

freeformTags Map<String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

id String

The OCID of the alarm.

isEnabled Boolean

Whether the alarm is enabled. Example: true

isNotificationsPerMetricDimensionEnabled Boolean

Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true

messageFormat String

The format to use for alarm notifications. The formats are:

RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format.
PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only.
ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only.

metricCompartmentId String

The OCID of the compartment containing the metric being evaluated by the alarm.

metricCompartmentIdInSubtree Boolean

namespace String

The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent

notificationTitle String

notificationVersion String

The version of the alarm notification to be delivered. Allowed value: 1.X The value must start with a number (up to four digits), followed by a period and an uppercase X.

overrides List<Property Map>

A set of overrides that control evaluations of the alarm.

pendingDuration String

query String

repeatNotificationDuration String

resolution String

The time between calculated aggregation windows for the alarm. Supported value: 1m

resourceGroup String

ruleName String

Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.

severity String

The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

state String

A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

suppressions List<Property Map>

The configuration details for suppressing an alarm.

timeCreated String

The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z

timeUpdated String

The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z

GetAlarmsAlarmOverride

Body string: The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
PendingDuration string: The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
Query string: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
RuleName string: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
Severity string: The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

Body string: The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
PendingDuration string: The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
Query string: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
RuleName string: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
Severity string: The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

body String: The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
pendingDuration String: The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
query String: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
ruleName String: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
severity String: The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

body string: The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
pendingDuration string: The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
query string: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
ruleName string: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
severity string: The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

body str: The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
pending_duration str: The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
query str: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
rule_name str: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
severity str: The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

body String: The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution.
pendingDuration String: The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
query String: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
ruleName String: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride.
severity String: The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

GetAlarmsAlarmSuppression

Description string: Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
TimeSuppressFrom string: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
TimeSuppressUntil string: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

Description string: Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
TimeSuppressFrom string: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
TimeSuppressUntil string: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

description String: Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
timeSuppressFrom String: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
timeSuppressUntil String: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

description string: Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
timeSuppressFrom string: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
timeSuppressUntil string: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

description str: Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
time_suppress_from str: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
time_suppress_until str: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

description String: Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
timeSuppressFrom String: The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
timeSuppressUntil String: The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

GetAlarmsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.Monitoring.getAlarms

On this page

On this page

Example Usage

Using getAlarms

getAlarms Result

Supporting Types

GetAlarmsAlarm

GetAlarmsAlarmOverride

GetAlarmsAlarmSuppression

GetAlarmsFilter

Package Details

On this page

On this page