Show / Hide Table of Contents

Class GetAlarmHistoryRequest

Inheritance
object
GetAlarmHistoryRequest
Implements
IOciRequest
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.MonitoringService.Requests
Assembly: OCI.DotNetSDK.Monitoring.dll
Syntax
public class GetAlarmHistoryRequest : IOciRequest
Examples

Click here to see an example of how to use GetAlarmHistory request.

Properties

AlarmHistorytype

Declaration
[HttpConverter(TargetEnum.Query, "alarmHistorytype")]
public GetAlarmHistoryRequest.AlarmHistorytypeEnum? AlarmHistorytype { get; set; }
Property Value
Type Description
GetAlarmHistoryRequest.AlarmHistorytypeEnum?

The type of history entries to retrieve. State history (STATE_HISTORY), state transition history (STATE_TRANSITION_HISTORY), rule history (RULE_HISTORY) or rule transition history (RULE_TRANSITION_HISTORY). If not specified, entries of all types are retrieved.
Example: STATE_HISTORY

AlarmId

Declaration
[Required(ErrorMessage = "AlarmId is required.")]
[HttpConverter(TargetEnum.Path, "alarmId")]
public string AlarmId { get; set; }
Property Value
Type Description
string

The OCID of an alarm.

Remarks

Required

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

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
Example: 500

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

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.

TimestampGreaterThanOrEqualTo

Declaration
[HttpConverter(TargetEnum.Query, "timestampGreaterThanOrEqualTo")]
public DateTime? TimestampGreaterThanOrEqualTo { get; set; }
Property Value
Type Description
DateTime?

A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.
Example: 2023-01-01T01:00:00.789Z

TimestampLessThan

Declaration
[HttpConverter(TargetEnum.Query, "timestampLessThan")]
public DateTime? TimestampLessThan { get; set; }
Property Value
Type Description
DateTime?

A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.
Example: 2023-01-02T01:00:00.789Z

Implements

IOciRequest
In this article
Back to top