Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace RequestSummarizedMetricDataDetails

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

Properties

compartmentId

compartmentId: string

The OCID of the compartment to use for authorization to read metrics. To use the root compartment, provide the tenancyId.

Optional dimensions

dimensions: undefined | object

Qualifiers to use when searching for metric data. For a list of valid dimensions for a given metric, see {@link #listMetricProperties(ListMetricPropertiesRequest) listMetricProperties}.

Optional endTime

endTime: Date

The end of the sampled time range to use when searching for metric data points. Format is defined by <a href="https://www.rfc-editor.org/rfc/rfc3339\">RFC3339. The response excludes metric data points for sampled time. Example 2019-02-01T02:02:29.600Z

metricName

metricName: string

The name of a metric for retrieving aggregated data. For a list of valid metrics for a given namespace, see {@link #listMetricProperties(ListMetricPropertiesRequest) listMetricProperties}.

namespaceName

namespaceName: string

The source service or application to use when searching for metric data points to aggregate. For a list of valid namespaces, see {@link #listNamespaces(ListNamespacesRequest) listNamespaces}.

Optional startTime

startTime: Date

The beginning of the sampled time range to use when searching for metric data points. Format is defined by <a href="https://www.rfc-editor.org/rfc/rfc3339\">RFC3339. The response includes metric data points for the sampled time. Example 2019-02-01T02:02:29.600Z

Functions

getDeserializedJsonObj

getJsonObj