Class AlarmStatusSummary

A summary of properties for the specified alarm and its current evaluation status. For information about alarms, see Alarms Overview.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.

Inheritance

object

AlarmStatusSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MonitoringService.Models

Assembly: OCI.DotNetSDK.Monitoring.dll

Syntax

public class AlarmStatusSummary

Properties

AlarmSummary

Declaration

[Required(ErrorMessage = "AlarmSummary is required.")]
[JsonProperty(PropertyName = "alarmSummary")]
public string AlarmSummary { get; set; }

Property Value

Type

Description

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 {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}.

Remarks

Required

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The configured name of the alarm. Example: High CPU Utilization

Remarks

Required

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the alarm.

Remarks

Required

RuleName

Declaration

[Required(ErrorMessage = "RuleName is required.")]
[JsonProperty(PropertyName = "ruleName")]
public string RuleName { get; set; }

Property Value

Type	Description
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 {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}.

Remarks

Required

Severity

Declaration

[Required(ErrorMessage = "Severity is required.")]
[JsonProperty(PropertyName = "severity")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AlarmStatusSummary.SeverityEnum? Severity { get; set; }

Property Value

Type	Description
AlarmStatusSummary.SeverityEnum?	The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

Remarks

Required

Status

Declaration

[Required(ErrorMessage = "Status is required.")]
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AlarmStatusSummary.StatusEnum? Status { get; set; }

Property Value

Type	Description
AlarmStatusSummary.StatusEnum?	The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. Example: FIRING

Remarks

Required

Suppression

Declaration

[JsonProperty(PropertyName = "suppression")]
public Suppression Suppression { get; set; }

Property Value

Type	Description
Suppression	The configuration details for suppressing an alarm.

TimestampTriggered

Declaration

[Required(ErrorMessage = "TimestampTriggered is required.")]
[JsonProperty(PropertyName = "timestampTriggered")]
public DateTime? TimestampTriggered { get; set; }

Property Value

Type	Description
DateTime?	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

Remarks

Required