Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SummarizeMetricsDataDetails

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

Properties

Optional endTime

endTime: Date

The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent.

Example: {@code 2023-02-01T02:02:29.600Z}

namespace

namespace: string

The source service or application to use when searching for metric data points to aggregate.

Example: {@code oci_computeagent}

query

query: string

The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate. The query must specify a metric, statistic, and interval. Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. When specifying a dimension value, surround it with double quotes, and escape each double quote with a backslash ({@code \}) character. Supported grouping functions: {@code grouping()}, {@code groupBy()}.

Construct your query to avoid exceeding limits on returned data. See MetricData.

For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).

Example 1: {@code CpuUtilization[1m].sum()}

Example 2 (escaped double quotes for value string): {@code CpuUtilization[1m]{resourceId = \\\"<instance_OCID>\\\"}.max()}

Optional resolution

resolution: undefined | string

The time between calculated aggregation windows. Use with the query interval to vary the frequency for returning aggregated data points. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: {@code 1m}-{@code 60m}, {@code 1h}-{@code 24h}, {@code 1d}.

Example: {@code 5m}

Optional resourceGroup

resourceGroup: undefined | string

Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).

Example: {@code frontend-fleet}

Optional startTime

startTime: Date

The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent.

Example: {@code 2023-02-01T01:02:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj