SummarizeMetricsDataDetails¶

class oci.monitoring.models.SummarizeMetricsDataDetails(**kwargs)¶

Bases: object

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

Methods

__init__(**kwargs) Initializes a new SummarizeMetricsDataDetails object with values from keyword arguments.

Attributes

`end_time`	Gets the end_time of this SummarizeMetricsDataDetails.
`namespace`	[Required] Gets the namespace of this SummarizeMetricsDataDetails.
`query`	[Required] Gets the query of this SummarizeMetricsDataDetails.
`resolution`	Gets the resolution of this SummarizeMetricsDataDetails.
`resource_group`	Gets the resource_group of this SummarizeMetricsDataDetails.
`start_time`	Gets the start_time of this SummarizeMetricsDataDetails.

__init__(**kwargs)¶

Initializes a new SummarizeMetricsDataDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

namespace (str) – The value to assign to the namespace property of this SummarizeMetricsDataDetails.
resource_group (str) – The value to assign to the resource_group property of this SummarizeMetricsDataDetails.
query (str) – The value to assign to the query property of this SummarizeMetricsDataDetails.
start_time (datetime) – The value to assign to the start_time property of this SummarizeMetricsDataDetails.
end_time (datetime) – The value to assign to the end_time property of this SummarizeMetricsDataDetails.
resolution (str) – The value to assign to the resolution property of this SummarizeMetricsDataDetails.

end_time¶

Gets the end_time of this SummarizeMetricsDataDetails. 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

Returns:	The end_time of this SummarizeMetricsDataDetails.
Return type:	datetime

namespace¶

[Required] Gets the namespace of this SummarizeMetricsDataDetails. The source service or application to use when searching for metric data points to aggregate.

Example: oci_computeagent

Returns:	The namespace of this SummarizeMetricsDataDetails.
Return type:	str

query¶

[Required] Gets the query of this SummarizeMetricsDataDetails. 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 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()

Returns:	The query of this SummarizeMetricsDataDetails.
Return type:	str

resolution¶

Gets the resolution of this SummarizeMetricsDataDetails. 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

Returns:	The resolution of this SummarizeMetricsDataDetails.
Return type:	str

resource_group¶

Gets the resource_group of this SummarizeMetricsDataDetails. 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

Returns:	The resource_group of this SummarizeMetricsDataDetails.
Return type:	str

start_time¶

Gets the start_time of this SummarizeMetricsDataDetails. 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

Returns:	The start_time of this SummarizeMetricsDataDetails.
Return type:	datetime