Class SummarizeMetricsDataDetails
The request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.
Inherited Members
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.
|
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.
|
Remarks
Required
Query
Declaration
[Required(ErrorMessage = "Query is required.")]
[JsonProperty(PropertyName = "query")]
public string Query { get; set; }
Property Value
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 ( |
Remarks
Required
Resolution
Declaration
[JsonProperty(PropertyName = "resolution")]
public string Resolution { get; set; }
Property Value
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: |
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 ($).
|
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.
|