Class SummarizeMetricsDataDetails

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

Inheritance

object

SummarizeMetricsDataDetails

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 SummarizeMetricsDataDetails

Properties

EndTime

Declaration

[JsonProperty(PropertyName = "endTime")]
public DateTime? EndTime { get; set; }

Property Value

Type	Description
DateTime?	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: 2023-02-01T02:02:29.600Z

Namespace

Declaration

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

Property Value

Type	Description
string	The source service or application to use when searching for metric data points to aggregate. Example: oci_computeagent

Remarks

Required

Query

Declaration

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

Property Value

Type Description

Type	Description
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 (`\\`) character. Supported grouping functions: `grouping()`, `groupBy()`. Construct your query to avoid exceeding limits on returned data. See {@link MetricData}. For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services. Example 1: `CpuUtilization[1m].sum()` Example 2 (escaped double quotes for value string): `CpuUtilization[1m]{resourceId = \\\"<var><instance_OCID></var>\\\"}.max()`

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 (\\) character. Supported grouping functions: grouping(), groupBy().
Construct your query to avoid exceeding limits on returned data. See {@link MetricData}.
For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
Example 1: CpuUtilization[1m].sum()
Example 2 (escaped double quotes for value string): CpuUtilization[1m]{resourceId = \\\"<var><instance_OCID></var>\\\"}.max()

Remarks

Required

Resolution

Declaration

[JsonProperty(PropertyName = "resolution")]
public string Resolution { get; set; }

Property Value

Type Description

Type	Description
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: `1m`-`60m`, `1h`-`24h`, `1d`. Example: 5m

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: 1m-60m, 1h-24h, 1d.
Example: 5m

ResourceGroup

Declaration

[JsonProperty(PropertyName = "resourceGroup")]
public string ResourceGroup { get; set; }

Property Value

Type	Description
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: frontend-fleet

Type

Description

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: frontend-fleet

StartTime

Declaration

[JsonProperty(PropertyName = "startTime")]
public DateTime? StartTime { get; set; }

Property Value

Type	Description
DateTime?	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: 2023-02-01T01:02:29.600Z