Oracle Cloud Infrastructure v1.31.0, Apr 10 24

Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.Monitoring.getAlarmStatuses

Explore with Pulumi AI

Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

List the status of each alarm in the specified compartment. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use RetrieveDimensionStates. The alarm attribute isNotificationsPerMetricDimensionEnabled must be set to true. For more information, see Listing Alarm Statuses. 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.

Example Usage

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

const testAlarmStatuses = oci.Monitoring.getAlarmStatuses({
    compartmentId: _var.compartment_id,
    compartmentIdInSubtree: _var.alarm_status_compartment_id_in_subtree,
    displayName: _var.alarm_status_display_name,
    entityId: oci_monitoring_entity.test_entity.id,
    resourceId: oci_monitoring_resource.test_resource.id,
    serviceName: oci_core_service.test_service.name,
    status: _var.alarm_status_status,
});

import pulumi
import pulumi_oci as oci

test_alarm_statuses = oci.Monitoring.get_alarm_statuses(compartment_id=var["compartment_id"],
    compartment_id_in_subtree=var["alarm_status_compartment_id_in_subtree"],
    display_name=var["alarm_status_display_name"],
    entity_id=oci_monitoring_entity["test_entity"]["id"],
    resource_id=oci_monitoring_resource["test_resource"]["id"],
    service_name=oci_core_service["test_service"]["name"],
    status=var["alarm_status_status"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Monitoring.GetAlarmStatuses(ctx, &monitoring.GetAlarmStatusesArgs{
			CompartmentId:          _var.Compartment_id,
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Alarm_status_compartment_id_in_subtree),
			DisplayName:            pulumi.StringRef(_var.Alarm_status_display_name),
			EntityId:               pulumi.StringRef(oci_monitoring_entity.Test_entity.Id),
			ResourceId:             pulumi.StringRef(oci_monitoring_resource.Test_resource.Id),
			ServiceName:            pulumi.StringRef(oci_core_service.Test_service.Name),
			Status:                 pulumi.StringRef(_var.Alarm_status_status),
		}, 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 testAlarmStatuses = Oci.Monitoring.GetAlarmStatuses.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        CompartmentIdInSubtree = @var.Alarm_status_compartment_id_in_subtree,
        DisplayName = @var.Alarm_status_display_name,
        EntityId = oci_monitoring_entity.Test_entity.Id,
        ResourceId = oci_monitoring_resource.Test_resource.Id,
        ServiceName = oci_core_service.Test_service.Name,
        Status = @var.Alarm_status_status,
    });

});

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.GetAlarmStatusesArgs;
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 testAlarmStatuses = MonitoringFunctions.getAlarmStatuses(GetAlarmStatusesArgs.builder()
            .compartmentId(var_.compartment_id())
            .compartmentIdInSubtree(var_.alarm_status_compartment_id_in_subtree())
            .displayName(var_.alarm_status_display_name())
            .entityId(oci_monitoring_entity.test_entity().id())
            .resourceId(oci_monitoring_resource.test_resource().id())
            .serviceName(oci_core_service.test_service().name())
            .status(var_.alarm_status_status())
            .build());

    }
}

variables:
  testAlarmStatuses:
    fn::invoke:
      Function: oci:Monitoring:getAlarmStatuses
      Arguments:
        compartmentId: ${var.compartment_id}
        compartmentIdInSubtree: ${var.alarm_status_compartment_id_in_subtree}
        displayName: ${var.alarm_status_display_name}
        entityId: ${oci_monitoring_entity.test_entity.id}
        resourceId: ${oci_monitoring_resource.test_resource.id}
        serviceName: ${oci_core_service.test_service.name}
        status: ${var.alarm_status_status}

Using getAlarmStatuses

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 getAlarmStatuses(args: GetAlarmStatusesArgs, opts?: InvokeOptions): Promise<GetAlarmStatusesResult>
function getAlarmStatusesOutput(args: GetAlarmStatusesOutputArgs, opts?: InvokeOptions): Output<GetAlarmStatusesResult>

def get_alarm_statuses(compartment_id: Optional[str] = None,
                       compartment_id_in_subtree: Optional[bool] = None,
                       display_name: Optional[str] = None,
                       entity_id: Optional[str] = None,
                       filters: Optional[Sequence[_monitoring.GetAlarmStatusesFilter]] = None,
                       resource_id: Optional[str] = None,
                       service_name: Optional[str] = None,
                       status: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetAlarmStatusesResult
def get_alarm_statuses_output(compartment_id: Optional[pulumi.Input[str]] = None,
                       compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                       display_name: Optional[pulumi.Input[str]] = None,
                       entity_id: Optional[pulumi.Input[str]] = None,
                       filters: Optional[pulumi.Input[Sequence[pulumi.Input[_monitoring.GetAlarmStatusesFilterArgs]]]] = None,
                       resource_id: Optional[pulumi.Input[str]] = None,
                       service_name: Optional[pulumi.Input[str]] = None,
                       status: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetAlarmStatusesResult]

func GetAlarmStatuses(ctx *Context, args *GetAlarmStatusesArgs, opts ...InvokeOption) (*GetAlarmStatusesResult, error)
func GetAlarmStatusesOutput(ctx *Context, args *GetAlarmStatusesOutputArgs, opts ...InvokeOption) GetAlarmStatusesResultOutput

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

public static class GetAlarmStatuses 
{
    public static Task<GetAlarmStatusesResult> InvokeAsync(GetAlarmStatusesArgs args, InvokeOptions? opts = null)
    public static Output<GetAlarmStatusesResult> Invoke(GetAlarmStatusesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAlarmStatusesResult> getAlarmStatuses(GetAlarmStatusesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Monitoring/getAlarmStatuses:getAlarmStatuses
  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.
EntityId string: The OCID of the entity monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
Filters List<GetAlarmStatusesFilter>
ResourceId string: The OCID of a resource that is monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
ServiceName string: A filter to return only resources that match the given service name exactly. Use this filter to list all alarms containing metric streams that match the exact service-name dimension. Example: logging-analytics
Status string: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING

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.
EntityId string: The OCID of the entity monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
Filters []GetAlarmStatusesFilter
ResourceId string: The OCID of a resource that is monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
ServiceName string: A filter to return only resources that match the given service name exactly. Use this filter to list all alarms containing metric streams that match the exact service-name dimension. Example: logging-analytics
Status string: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING

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.
entityId String: The OCID of the entity monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
filters List<GetAlarmStatusesFilter>
resourceId String: The OCID of a resource that is monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
serviceName String: A filter to return only resources that match the given service name exactly. Use this filter to list all alarms containing metric streams that match the exact service-name dimension. Example: logging-analytics
status String: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING

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.
entityId string: The OCID of the entity monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
filters GetAlarmStatusesFilter[]
resourceId string: The OCID of a resource that is monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
serviceName string: A filter to return only resources that match the given service name exactly. Use this filter to list all alarms containing metric streams that match the exact service-name dimension. Example: logging-analytics
status string: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING

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.
entity_id str: The OCID of the entity monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
filters Sequence[monitoring.GetAlarmStatusesFilter]
resource_id str: The OCID of a resource that is monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
service_name str: A filter to return only resources that match the given service name exactly. Use this filter to list all alarms containing metric streams that match the exact service-name dimension. Example: logging-analytics
status str: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING

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.
entityId String: The OCID of the entity monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
filters List<Property Map>
resourceId String: The OCID of a resource that is monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID
serviceName String: A filter to return only resources that match the given service name exactly. Use this filter to list all alarms containing metric streams that match the exact service-name dimension. Example: logging-analytics
status String: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING

getAlarmStatuses Result

The following output properties are available:

AlarmStatuses List<GetAlarmStatusesAlarmStatus>: The list of alarm_statuses.
CompartmentId string
Id string: The provider-assigned unique ID for this managed resource.
CompartmentIdInSubtree bool
DisplayName string: The configured name of the alarm. Example: High CPU Utilization
EntityId string
Filters List<GetAlarmStatusesFilter>
ResourceId string
ServiceName string
Status string: The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use RetrieveDimensionStates. The alarm attribute isNotificationsPerMetricDimensionEnabled must be set to true. Example: FIRING

AlarmStatuses []GetAlarmStatusesAlarmStatus: The list of alarm_statuses.
CompartmentId string
Id string: The provider-assigned unique ID for this managed resource.
CompartmentIdInSubtree bool
DisplayName string: The configured name of the alarm. Example: High CPU Utilization
EntityId string
Filters []GetAlarmStatusesFilter
ResourceId string
ServiceName string
Status string: The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use RetrieveDimensionStates. The alarm attribute isNotificationsPerMetricDimensionEnabled must be set to true. Example: FIRING

alarmStatuses List<GetAlarmStatusesAlarmStatus>: The list of alarm_statuses.
compartmentId String
id String: The provider-assigned unique ID for this managed resource.
compartmentIdInSubtree Boolean
displayName String: The configured name of the alarm. Example: High CPU Utilization
entityId String
filters List<GetAlarmStatusesFilter>
resourceId String
serviceName String
status String: The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use RetrieveDimensionStates. The alarm attribute isNotificationsPerMetricDimensionEnabled must be set to true. Example: FIRING

alarmStatuses GetAlarmStatusesAlarmStatus[]: The list of alarm_statuses.
compartmentId string
id string: The provider-assigned unique ID for this managed resource.
compartmentIdInSubtree boolean
displayName string: The configured name of the alarm. Example: High CPU Utilization
entityId string
filters GetAlarmStatusesFilter[]
resourceId string
serviceName string
status string: The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use RetrieveDimensionStates. The alarm attribute isNotificationsPerMetricDimensionEnabled must be set to true. Example: FIRING

alarm_statuses Sequence[monitoring.GetAlarmStatusesAlarmStatus]: The list of alarm_statuses.
compartment_id str
id str: The provider-assigned unique ID for this managed resource.
compartment_id_in_subtree bool
display_name str: The configured name of the alarm. Example: High CPU Utilization
entity_id str
filters Sequence[monitoring.GetAlarmStatusesFilter]
resource_id str
service_name str
status str: The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use RetrieveDimensionStates. The alarm attribute isNotificationsPerMetricDimensionEnabled must be set to true. Example: FIRING

alarmStatuses List<Property Map>: The list of alarm_statuses.
compartmentId String
id String: The provider-assigned unique ID for this managed resource.
compartmentIdInSubtree Boolean
displayName String: The configured name of the alarm. Example: High CPU Utilization
entityId String
filters List<Property Map>
resourceId String
serviceName String
status String: The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use RetrieveDimensionStates. The alarm attribute isNotificationsPerMetricDimensionEnabled must be set to true. Example: FIRING

Supporting Types

GetAlarmStatusesAlarmStatus

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.
Id string: The OCID of the alarm.
RuleName string: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. 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
Status string: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING
Suppressions List<GetAlarmStatusesAlarmStatusSuppression>: The configuration details for suppressing an alarm.
TimestampTriggered string: Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: 2023-02-01T01:02:29.600Z

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.
Id string: The OCID of the alarm.
RuleName string: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. 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
Status string: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING
Suppressions []GetAlarmStatusesAlarmStatusSuppression: The configuration details for suppressing an alarm.
TimestampTriggered string: Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: 2023-02-01T01:02:29.600Z

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.
id String: The OCID of the alarm.
ruleName String: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. 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
status String: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING
suppressions List<GetAlarmStatusesAlarmStatusSuppression>: The configuration details for suppressing an alarm.
timestampTriggered String: Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: 2023-02-01T01:02:29.600Z

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.
id string: The OCID of the alarm.
ruleName string: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. 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
status string: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING
suppressions GetAlarmStatusesAlarmStatusSuppression[]: The configuration details for suppressing an alarm.
timestampTriggered string: Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: 2023-02-01T01:02:29.600Z

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.
id str: The OCID of the alarm.
rule_name str: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. 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
status str: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING
suppressions Sequence[monitoring.GetAlarmStatusesAlarmStatusSuppression]: The configuration details for suppressing an alarm.
timestamp_triggered str: Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: 2023-02-01T01:02:29.600Z

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.
id String: The OCID of the alarm.
ruleName String: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. 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
status String: The status of the metric stream to use for alarm filtering. For example, set StatusQueryParam to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: FIRING
suppressions List<Property Map>: The configuration details for suppressing an alarm.
timestampTriggered String: Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: 2023-02-01T01:02:29.600Z

GetAlarmStatusesAlarmStatusSuppression

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

GetAlarmStatusesFilter

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 v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

pulumi/pulumi-oci

oci.Monitoring.getAlarmStatuses

On this page

On this page

Example Usage

Using getAlarmStatuses

getAlarmStatuses Result

Supporting Types

GetAlarmStatusesAlarmStatus

GetAlarmStatusesAlarmStatusSuppression

GetAlarmStatusesFilter

Package Details

On this page

On this page