Docs Home
Packages
oci.Monitoring.getMetricData
Explore with Pulumi AI
This data source provides the list of Metric Data in Oracle Cloud Infrastructure Monitoring service.
Returns aggregated data that match the criteria specified in the request. Compartment OCID required. For more information, see Querying Metric Data and Creating a Query. For important limits information, see Limits on Monitoring.
Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testMetricData = oci.Monitoring.getMetricData({
compartmentId: compartmentId,
namespace: metricDataNamespace,
query: metricDataQuery,
compartmentIdInSubtree: metricDataCompartmentIdInSubtree,
endTime: metricDataEndTime,
resolution: metricDataResolution,
resourceGroup: metricDataResourceGroup,
startTime: metricDataStartTime,
});
import pulumi
import pulumi_oci as oci
test_metric_data = oci.Monitoring.get_metric_data(compartment_id=compartment_id,
namespace=metric_data_namespace,
query=metric_data_query,
compartment_id_in_subtree=metric_data_compartment_id_in_subtree,
end_time=metric_data_end_time,
resolution=metric_data_resolution,
resource_group=metric_data_resource_group,
start_time=metric_data_start_time)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Monitoring.GetMetricData(ctx, &monitoring.GetMetricDataArgs{
CompartmentId: compartmentId,
Namespace: metricDataNamespace,
Query: metricDataQuery,
CompartmentIdInSubtree: pulumi.BoolRef(metricDataCompartmentIdInSubtree),
EndTime: pulumi.StringRef(metricDataEndTime),
Resolution: pulumi.StringRef(metricDataResolution),
ResourceGroup: pulumi.StringRef(metricDataResourceGroup),
StartTime: pulumi.StringRef(metricDataStartTime),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testMetricData = Oci.Monitoring.GetMetricData.Invoke(new()
{
CompartmentId = compartmentId,
Namespace = metricDataNamespace,
Query = metricDataQuery,
CompartmentIdInSubtree = metricDataCompartmentIdInSubtree,
EndTime = metricDataEndTime,
Resolution = metricDataResolution,
ResourceGroup = metricDataResourceGroup,
StartTime = metricDataStartTime,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Monitoring.MonitoringFunctions;
import com.pulumi.oci.Monitoring.inputs.GetMetricDataArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var testMetricData = MonitoringFunctions.getMetricData(GetMetricDataArgs.builder()
.compartmentId(compartmentId)
.namespace(metricDataNamespace)
.query(metricDataQuery)
.compartmentIdInSubtree(metricDataCompartmentIdInSubtree)
.endTime(metricDataEndTime)
.resolution(metricDataResolution)
.resourceGroup(metricDataResourceGroup)
.startTime(metricDataStartTime)
.build());
}
}
variables:
testMetricData:
fn::invoke:
Function: oci:Monitoring:getMetricData
Arguments:
compartmentId: ${compartmentId}
namespace: ${metricDataNamespace}
query: ${metricDataQuery}
compartmentIdInSubtree: ${metricDataCompartmentIdInSubtree}
endTime: ${metricDataEndTime}
resolution: ${metricDataResolution}
resourceGroup: ${metricDataResourceGroup}
startTime: ${metricDataStartTime}
Using getMetricData
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getMetricData(args: GetMetricDataArgs, opts?: InvokeOptions): Promise<GetMetricDataResult>
function getMetricDataOutput(args: GetMetricDataOutputArgs, opts?: InvokeOptions): Output<GetMetricDataResult>def get_metric_data(compartment_id: Optional[str] = None,
compartment_id_in_subtree: Optional[bool] = None,
end_time: Optional[str] = None,
filters: Optional[Sequence[_monitoring.GetMetricDataFilter]] = None,
namespace: Optional[str] = None,
query: Optional[str] = None,
resolution: Optional[str] = None,
resource_group: Optional[str] = None,
start_time: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetMetricDataResult
def get_metric_data_output(compartment_id: Optional[pulumi.Input[str]] = None,
compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
end_time: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_monitoring.GetMetricDataFilterArgs]]]] = None,
namespace: Optional[pulumi.Input[str]] = None,
query: Optional[pulumi.Input[str]] = None,
resolution: Optional[pulumi.Input[str]] = None,
resource_group: Optional[pulumi.Input[str]] = None,
start_time: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetMetricDataResult]func GetMetricData(ctx *Context, args *GetMetricDataArgs, opts ...InvokeOption) (*GetMetricDataResult, error)
func GetMetricDataOutput(ctx *Context, args *GetMetricDataOutputArgs, opts ...InvokeOption) GetMetricDataResultOutput> Note: This function is named GetMetricData in the Go SDK.
public static class GetMetricData
{
public static Task<GetMetricDataResult> InvokeAsync(GetMetricDataArgs args, InvokeOptions? opts = null)
public static Output<GetMetricDataResult> Invoke(GetMetricDataInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetMetricDataResult> getMetricData(GetMetricDataArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Monitoring/getMetricData:getMetricData
arguments:
# arguments dictionaryThe following arguments are supported:
- Compartment
Id string - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - Namespace string
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - 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 (
\) character. Supported grouping functions:grouping(),groupBy().Construct your query to avoid exceeding limits on returned data. See MetricData Reference.
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()- Compartment
Id boolIn Subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- End
Time string - 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 - Filters
List<Get
Metric Data Filter> - Resolution 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 - Resource
Group 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 - Start
Time string - 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
- Compartment
Id string - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - Namespace string
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - 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 (
\) character. Supported grouping functions:grouping(),groupBy().Construct your query to avoid exceeding limits on returned data. See MetricData Reference.
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()- Compartment
Id boolIn Subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- End
Time string - 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 - Filters
[]Get
Metric Data Filter - Resolution 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 - Resource
Group 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 - Start
Time string - 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
- compartment
Id String - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - namespace String
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - 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 (
\) character. Supported grouping functions:grouping(),groupBy().Construct your query to avoid exceeding limits on returned data. See MetricData Reference.
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()- compartment
Id BooleanIn Subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- end
Time String - 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 - filters
List<Get
Metric Data Filter> - resolution 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 - resource
Group 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 - start
Time String - 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
- compartment
Id string - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - namespace string
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - 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 (
\) character. Supported grouping functions:grouping(),groupBy().Construct your query to avoid exceeding limits on returned data. See MetricData Reference.
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()- compartment
Id booleanIn Subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- end
Time string - 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 - filters
Get
Metric Data Filter[] - resolution 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 - resource
Group 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 - start
Time string - 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
- compartment_
id str - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - namespace str
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - query str
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 Reference.
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()- compartment_
id_ boolin_ subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- end_
time str - 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 - filters
Sequence[monitoring.
Get Metric Data Filter] - resolution str
- 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 - resource_
group str - 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 - start_
time str - 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
- compartment
Id String - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - namespace String
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - 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 (
\) character. Supported grouping functions:grouping(),groupBy().Construct your query to avoid exceeding limits on returned data. See MetricData Reference.
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()- compartment
Id BooleanIn Subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- end
Time String - 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 - filters List<Property Map>
- resolution 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 - resource
Group 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 - start
Time String - 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
getMetricData Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment containing the resources that the aggregated data was returned from.
- Id string
- The provider-assigned unique ID for this managed resource.
- Metric
Datas List<GetMetric Data Metric Data> - The list of metric_data.
- Namespace string
- The reference provided in a metric definition to indicate the source service or application that emitted the metric. Example:
oci_computeagent - Query string
- Compartment
Id boolIn Subtree - End
Time string - Filters
List<Get
Metric Data Filter> - Resolution 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 - Resource
Group string - Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. 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 - Start
Time string
- Compartment
Id string - The OCID of the compartment containing the resources that the aggregated data was returned from.
- Id string
- The provider-assigned unique ID for this managed resource.
- Metric
Datas []GetMetric Data Metric Data - The list of metric_data.
- Namespace string
- The reference provided in a metric definition to indicate the source service or application that emitted the metric. Example:
oci_computeagent - Query string
- Compartment
Id boolIn Subtree - End
Time string - Filters
[]Get
Metric Data Filter - Resolution 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 - Resource
Group string - Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. 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 - Start
Time string
- compartment
Id String - The OCID of the compartment containing the resources that the aggregated data was returned from.
- id String
- The provider-assigned unique ID for this managed resource.
- metric
Datas List<GetMetric Data Metric Data> - The list of metric_data.
- namespace String
- The reference provided in a metric definition to indicate the source service or application that emitted the metric. Example:
oci_computeagent - query String
- compartment
Id BooleanIn Subtree - end
Time String - filters
List<Get
Metric Data Filter> - resolution 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 - resource
Group String - Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. 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 - start
Time String
- compartment
Id string - The OCID of the compartment containing the resources that the aggregated data was returned from.
- id string
- The provider-assigned unique ID for this managed resource.
- metric
Datas GetMetric Data Metric Data[] - The list of metric_data.
- namespace string
- The reference provided in a metric definition to indicate the source service or application that emitted the metric. Example:
oci_computeagent - query string
- compartment
Id booleanIn Subtree - end
Time string - filters
Get
Metric Data Filter[] - resolution 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 - resource
Group string - Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. 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 - start
Time string
- compartment_
id str - The OCID of the compartment containing the resources that the aggregated data was returned from.
- id str
- The provider-assigned unique ID for this managed resource.
- metric_
datas Sequence[monitoring.Get Metric Data Metric Data] - The list of metric_data.
- namespace str
- The reference provided in a metric definition to indicate the source service or application that emitted the metric. Example:
oci_computeagent - query str
- compartment_
id_ boolin_ subtree - end_
time str - filters
Sequence[monitoring.
Get Metric Data Filter] - resolution str
- 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 - resource_
group str - Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. 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 - start_
time str
- compartment
Id String - The OCID of the compartment containing the resources that the aggregated data was returned from.
- id String
- The provider-assigned unique ID for this managed resource.
- metric
Datas List<Property Map> - The list of metric_data.
- namespace String
- The reference provided in a metric definition to indicate the source service or application that emitted the metric. Example:
oci_computeagent - query String
- compartment
Id BooleanIn Subtree - end
Time String - filters List<Property Map>
- resolution 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 - resource
Group String - Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. 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 - start
Time String
Supporting Types
GetMetricDataFilter
GetMetricDataMetricData
- Aggregated
Datapoints List<GetMetric Data Metric Data Aggregated Datapoint> - The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page.
- Compartment
Id string - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - Compartment
Id boolIn Subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- Dimensions Dictionary<string, string>
- Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example:
{"resourceId": "instance.region1.phx.exampleuniqueID"} - End
Time string - 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 - Metadata Dictionary<string, string>
- The references provided in a metric definition to indicate extra information about the metric. Example:
"unit": "bytes" - Name string
- The name of the metric. Example:
CpuUtilization - Namespace string
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - 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 (
\) character. Supported grouping functions:grouping(),groupBy().Construct your query to avoid exceeding limits on returned data. See MetricData Reference.
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()- Resolution 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 - Resource
Group 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 - Start
Time string - 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
- Aggregated
Datapoints []GetMetric Data Metric Data Aggregated Datapoint - The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page.
- Compartment
Id string - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - Compartment
Id boolIn Subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- Dimensions map[string]string
- Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example:
{"resourceId": "instance.region1.phx.exampleuniqueID"} - End
Time string - 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 - Metadata map[string]string
- The references provided in a metric definition to indicate extra information about the metric. Example:
"unit": "bytes" - Name string
- The name of the metric. Example:
CpuUtilization - Namespace string
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - 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 (
\) character. Supported grouping functions:grouping(),groupBy().Construct your query to avoid exceeding limits on returned data. See MetricData Reference.
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()- Resolution 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 - Resource
Group 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 - Start
Time string - 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
- aggregated
Datapoints List<GetMetric Data Metric Data Aggregated Datapoint> - The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page.
- compartment
Id String - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - compartment
Id BooleanIn Subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- dimensions Map<String,String>
- Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example:
{"resourceId": "instance.region1.phx.exampleuniqueID"} - end
Time String - 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 - metadata Map<String,String>
- The references provided in a metric definition to indicate extra information about the metric. Example:
"unit": "bytes" - name String
- The name of the metric. Example:
CpuUtilization - namespace String
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - 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 (
\) character. Supported grouping functions:grouping(),groupBy().Construct your query to avoid exceeding limits on returned data. See MetricData Reference.
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()- resolution 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 - resource
Group 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 - start
Time String - 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
- aggregated
Datapoints GetMetric Data Metric Data Aggregated Datapoint[] - The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page.
- compartment
Id string - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - compartment
Id booleanIn Subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- dimensions {[key: string]: string}
- Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example:
{"resourceId": "instance.region1.phx.exampleuniqueID"} - end
Time string - 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 - metadata {[key: string]: string}
- The references provided in a metric definition to indicate extra information about the metric. Example:
"unit": "bytes" - name string
- The name of the metric. Example:
CpuUtilization - namespace string
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - 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 (
\) character. Supported grouping functions:grouping(),groupBy().Construct your query to avoid exceeding limits on returned data. See MetricData Reference.
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()- resolution 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 - resource
Group 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 - start
Time string - 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
- aggregated_
datapoints Sequence[monitoring.Get Metric Data Metric Data Aggregated Datapoint] - The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page.
- compartment_
id str - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - compartment_
id_ boolin_ subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- dimensions Mapping[str, str]
- Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example:
{"resourceId": "instance.region1.phx.exampleuniqueID"} - end_
time str - 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 - metadata Mapping[str, str]
- The references provided in a metric definition to indicate extra information about the metric. Example:
"unit": "bytes" - name str
- The name of the metric. Example:
CpuUtilization - namespace str
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - query str
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 Reference.
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()- resolution str
- 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 - resource_
group str - 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 - start_
time str - 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
- aggregated
Datapoints List<Property Map> - The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page.
- compartment
Id String - The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example:
ocid1.compartment.oc1..exampleuniqueID - compartment
Id BooleanIn Subtree - When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
- dimensions Map<String>
- Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example:
{"resourceId": "instance.region1.phx.exampleuniqueID"} - end
Time String - 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 - metadata Map<String>
- The references provided in a metric definition to indicate extra information about the metric. Example:
"unit": "bytes" - name String
- The name of the metric. Example:
CpuUtilization - namespace String
- The source service or application to use when searching for metric data points to aggregate. Example:
oci_computeagent - 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 (
\) character. Supported grouping functions:grouping(),groupBy().Construct your query to avoid exceeding limits on returned data. See MetricData Reference.
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()- resolution 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 - resource
Group 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 - start
Time String - 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
GetMetricDataMetricDataAggregatedDatapoint
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.