Show / Hide Table of Contents

Namespace Oci.MonitoringService.Models

Classes

AggregatedDatapoint

A timestamp-value pair returned for the specified request.

Alarm

The properties that define an alarm. 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.

AlarmDimensionStatesCollection

The list of current alarm state entries for each metric stream that matches the filters.

AlarmDimensionStatesEntry

A timestamped alarm state entry for a metric stream.

AlarmHistoryCollection

The configuration details for retrieving alarm history.

AlarmHistoryEntry

An alarm history entry indicating a description of the entry and the time that the entry occurred. If the entry corresponds to a state transition, such as OK to Firing, then the entry also includes a transition timestamp.

AlarmOverride

Values to use for an independent evaluation of the alarm. You can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position 0), and then evaluates the alarm's base values (ruleName value of BASE)

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.

AlarmSummary

A summary of properties for the specified alarm. 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.

AlarmSuppression

The configuration details for an alarm suppression.

AlarmSuppressionAlarmTarget

The alarm target of the alarm suppression.

AlarmSuppressionCollection

Collection of property summaries for alarm suppressions.

AlarmSuppressionCompartmentTarget

The compartment target of the alarm suppression.

AlarmSuppressionHistoryItem

A summary of properties for the specified alarm suppression history item.

AlarmSuppressionHistoryItemCollection

Collection of property summaries for alarm suppression history items.

AlarmSuppressionSummary

A summary of properties for the specified alarm suppression.

AlarmSuppressionTarget

The target of the alarm suppression.

AlarmSuppressionTargetModelConverter

ChangeAlarmCompartmentDetails

The configuration details for moving an alarm.

CreateAlarmDetails

The configuration details for creating an alarm.

CreateAlarmSuppressionDetails

The configuration details for creating an alarm suppression.

Datapoint

Metric value for a specific timestamp.

FailedMetricRecord

The record of a single metric object that failed input validation and the reason for the failure.

ListMetricsDetails

The request details for retrieving metric definitions. Specify optional properties to filter the returned results. Use an asterisk () as a wildcard character, placed anywhere in the string. For example, to search for all metrics with names that begin with "disk", specify "name" as "disk". If no properties are specified, then all metric definitions within the request scope are returned.

Metric

The properties that define a metric. For information about metrics, see Metrics Overview.

MetricData

The set of aggregated data returned for a metric. For information about metrics, see Metrics Overview.
Limits information for returned data follows.

  • Data points: 100,000.
  • Metric streams* within data points: 2,000.
  • Time range returned for 1-day resolution: 90 days.
  • Time range returned for 1-hour resolution: 90 days.
  • Time range returned for 5-minute resolution: 30 days.
  • Time range returned for 1-minute resolution: 7 days.
    *A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. Metric streams cannot be aggregated across metric groups. A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. For more information about metric-related concepts, see Monitoring Concepts.

MetricDataDetails

A metric object containing raw metric data points to be posted to the Monitoring service.

PostMetricDataDetails

An array of metric objects containing raw metric data points to be posted to the Monitoring service.

PostMetricDataResponseDetails

The response object returned from a PostMetricData operation.

Recurrence

Alarm suppression recurring schedule. Only one recurrence condition is supported within the list of preconditions for a suppression (suppressionConditions).

RetrieveDimensionStatesDetails

The configuration details for retrieving the alarm state entries. Filter retrieved alarm state entries by status value and dimension key-value pairs.

SummarizeAlarmSuppressionHistoryDetails

The configuration details for returning history of suppressions for the specified alarm.

SummarizeMetricsDataDetails

The request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.

Suppression

The configuration details for an alarm-wide suppression. For dimension-specific suppressions, see {@link AlarmSuppression}.
For information about alarms, see Alarms Overview.

SuppressionCondition

Precondition for an alarm suppression within the suppression date and time range (timeSuppressFrom to timeSuppressUntil).

SuppressionConditionModelConverter

UpdateAlarmDetails

The configuration details for updating an alarm.

Enums

Alarm.LifecycleStateEnum

Alarm.MessageFormatEnum

Alarm.SeverityEnum

AlarmDimensionStatesEntry.StatusEnum

AlarmStatusSummary.SeverityEnum

AlarmStatusSummary.StatusEnum

AlarmSummary.SeverityEnum

AlarmSuppression.LevelEnum

AlarmSuppression.LifecycleStateEnum

AlarmSuppressionHistoryItem.LevelEnum

AlarmSuppressionTarget.TargetTypeEnum

CreateAlarmDetails.MessageFormatEnum

ListMetricsDetails.SortByEnum

ListMetricsDetails.SortOrderEnum

PostMetricDataDetails.BatchAtomicityEnum

SuppressionCondition.ConditionTypeEnum

UpdateAlarmDetails.MessageFormatEnum

In this article
Back to top