Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getMetricData

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 information on metric queries, see Building Metric Queries. For important limits information, see Limits on Monitoring.

Transactions Per Second (TPS) per-tenancy limit for this operation: 10.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testMetricData = Output.Create(Oci.Monitoring.GetMetricData.InvokeAsync(new Oci.Monitoring.GetMetricDataArgs
        {
            CompartmentId = @var.Compartment_id,
            Namespace = @var.Metric_data_namespace,
            Query = @var.Metric_data_query,
            CompartmentIdInSubtree = @var.Metric_data_compartment_id_in_subtree,
            EndTime = @var.Metric_data_end_time,
            Resolution = @var.Metric_data_resolution,
            ResourceGroup = @var.Metric_data_resource_group,
            StartTime = @var.Metric_data_start_time,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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:          _var.Compartment_id,
			Namespace:              _var.Metric_data_namespace,
			Query:                  _var.Metric_data_query,
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Metric_data_compartment_id_in_subtree),
			EndTime:                pulumi.StringRef(_var.Metric_data_end_time),
			Resolution:             pulumi.StringRef(_var.Metric_data_resolution),
			ResourceGroup:          pulumi.StringRef(_var.Metric_data_resource_group),
			StartTime:              pulumi.StringRef(_var.Metric_data_start_time),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_metric_data = oci.Monitoring.get_metric_data(compartment_id=var["compartment_id"],
    namespace=var["metric_data_namespace"],
    query=var["metric_data_query"],
    compartment_id_in_subtree=var["metric_data_compartment_id_in_subtree"],
    end_time=var["metric_data_end_time"],
    resolution=var["metric_data_resolution"],
    resource_group=var["metric_data_resource_group"],
    start_time=var["metric_data_start_time"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMetricData = oci.Monitoring.getMetricData({
    compartmentId: _var.compartment_id,
    namespace: _var.metric_data_namespace,
    query: _var.metric_data_query,
    compartmentIdInSubtree: _var.metric_data_compartment_id_in_subtree,
    endTime: _var.metric_data_end_time,
    resolution: _var.metric_data_resolution,
    resourceGroup: _var.metric_data_resource_group,
    startTime: _var.metric_data_start_time,
});

Coming soon!

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 dictionary

The following arguments are supported:

CompartmentId 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. Supported grouping functions: grouping(), groupBy().

CompartmentIdInSubtree bool

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.

EndTime 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: 2019-02-01T02:02:29.600Z

Filters List<GetMetricDataFilter>
Resolution string

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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 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: 2019-02-01T01:02:29.600Z

CompartmentId 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. Supported grouping functions: grouping(), groupBy().

CompartmentIdInSubtree bool

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.

EndTime 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: 2019-02-01T02:02:29.600Z

Filters []GetMetricDataFilter
Resolution string

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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 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: 2019-02-01T01:02:29.600Z

compartmentId 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. Supported grouping functions: grouping(), groupBy().

compartmentIdInSubtree Boolean

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.

endTime 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: 2019-02-01T02:02:29.600Z

filters List<GetMetricDataFilter>
resolution String

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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 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: 2019-02-01T01:02:29.600Z

compartmentId 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. Supported grouping functions: grouping(), groupBy().

compartmentIdInSubtree boolean

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.

endTime 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: 2019-02-01T02:02:29.600Z

filters GetMetricDataFilter[]
resolution string

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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 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: 2019-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. Supported grouping functions: grouping(), groupBy().

compartment_id_in_subtree bool

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: 2019-02-01T02:02:29.600Z

filters GetMetricDataFilter]
resolution str

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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: 2019-02-01T01:02:29.600Z

compartmentId 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. Supported grouping functions: grouping(), groupBy().

compartmentIdInSubtree Boolean

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.

endTime 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: 2019-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 at which aggregated data points are returned. 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 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 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: 2019-02-01T01:02:29.600Z

getMetricData Result

The following output properties are available:

CompartmentId string

The OCID of the compartment containing the resources from which the aggregated data was returned.

Id string

The provider-assigned unique ID for this managed resource.

MetricDatas List<GetMetricDataMetricData>

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
CompartmentIdInSubtree bool
EndTime string
Filters List<GetMetricDataFilter>
Resolution string

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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

StartTime string
CompartmentId string

The OCID of the compartment containing the resources from which the aggregated data was returned.

Id string

The provider-assigned unique ID for this managed resource.

MetricDatas []GetMetricDataMetricData

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
CompartmentIdInSubtree bool
EndTime string
Filters []GetMetricDataFilter
Resolution string

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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

StartTime string
compartmentId String

The OCID of the compartment containing the resources from which the aggregated data was returned.

id String

The provider-assigned unique ID for this managed resource.

metricDatas List<GetMetricDataMetricData>

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
compartmentIdInSubtree Boolean
endTime String
filters List<GetMetricDataFilter>
resolution String

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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

startTime String
compartmentId string

The OCID of the compartment containing the resources from which the aggregated data was returned.

id string

The provider-assigned unique ID for this managed resource.

metricDatas GetMetricDataMetricData[]

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
compartmentIdInSubtree boolean
endTime string
filters GetMetricDataFilter[]
resolution string

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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

startTime string
compartment_id str

The OCID of the compartment containing the resources from which the aggregated data was returned.

id str

The provider-assigned unique ID for this managed resource.

metric_datas GetMetricDataMetricData]

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_in_subtree bool
end_time str
filters GetMetricDataFilter]
resolution str

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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
compartmentId String

The OCID of the compartment containing the resources from which the aggregated data was returned.

id String

The provider-assigned unique ID for this managed resource.

metricDatas 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
compartmentIdInSubtree Boolean
endTime String
filters List<Property Map>
resolution String

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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

startTime String

Supporting Types

GetMetricDataFilter

Name string

The name of the metric. Example: CpuUtilization

Values List<string>
Regex bool
Name string

The name of the metric. Example: CpuUtilization

Values []string
Regex bool
name String

The name of the metric. Example: CpuUtilization

values List<String>
regex Boolean
name string

The name of the metric. Example: CpuUtilization

values string[]
regex boolean
name str

The name of the metric. Example: CpuUtilization

values Sequence[str]
regex bool
name String

The name of the metric. Example: CpuUtilization

values List<String>
regex Boolean

GetMetricDataMetricData

AggregatedDatapoints List<GetMetricDataMetricDataAggregatedDatapoint>

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.

CompartmentId 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

CompartmentIdInSubtree bool

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, object>

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": "ocid1.instance.region1.phx.exampleuniqueID"

EndTime 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: 2019-02-01T02:02:29.600Z

Metadata Dictionary<string, object>

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. Supported grouping functions: grouping(), groupBy().

Resolution string

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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 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: 2019-02-01T01:02:29.600Z

AggregatedDatapoints []GetMetricDataMetricDataAggregatedDatapoint

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.

CompartmentId 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

CompartmentIdInSubtree bool

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]interface{}

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": "ocid1.instance.region1.phx.exampleuniqueID"

EndTime 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: 2019-02-01T02:02:29.600Z

Metadata map[string]interface{}

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. Supported grouping functions: grouping(), groupBy().

Resolution string

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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 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: 2019-02-01T01:02:29.600Z

aggregatedDatapoints List<GetMetricDataMetricDataAggregatedDatapoint>

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.

compartmentId 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

compartmentIdInSubtree Boolean

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,Object>

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": "ocid1.instance.region1.phx.exampleuniqueID"

endTime 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: 2019-02-01T02:02:29.600Z

metadata Map<String,Object>

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. Supported grouping functions: grouping(), groupBy().

resolution String

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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 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: 2019-02-01T01:02:29.600Z

aggregatedDatapoints GetMetricDataMetricDataAggregatedDatapoint[]

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.

compartmentId 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

compartmentIdInSubtree boolean

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]: any}

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": "ocid1.instance.region1.phx.exampleuniqueID"

endTime 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: 2019-02-01T02:02:29.600Z

metadata {[key: string]: any}

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. Supported grouping functions: grouping(), groupBy().

resolution string

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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 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: 2019-02-01T01:02:29.600Z

aggregated_datapoints GetMetricDataMetricDataAggregatedDatapoint]

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_in_subtree bool

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, Any]

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": "ocid1.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: 2019-02-01T02:02:29.600Z

metadata Mapping[str, Any]

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. Supported grouping functions: grouping(), groupBy().

resolution str

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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: 2019-02-01T01:02:29.600Z

aggregatedDatapoints 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.

compartmentId 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

compartmentIdInSubtree Boolean

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<Any>

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": "ocid1.instance.region1.phx.exampleuniqueID"

endTime 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: 2019-02-01T02:02:29.600Z

metadata Map<Any>

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. Supported grouping functions: grouping(), groupBy().

resolution String

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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 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 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: 2019-02-01T01:02:29.600Z

GetMetricDataMetricDataAggregatedDatapoint

Timestamp string

The date and time associated with the value of this data point. Format defined by RFC3339. Example: 2019-02-01T01:02:29.600Z

Value double

Numeric value of the metric. Example: 10.4

Timestamp string

The date and time associated with the value of this data point. Format defined by RFC3339. Example: 2019-02-01T01:02:29.600Z

Value float64

Numeric value of the metric. Example: 10.4

timestamp String

The date and time associated with the value of this data point. Format defined by RFC3339. Example: 2019-02-01T01:02:29.600Z

value Double

Numeric value of the metric. Example: 10.4

timestamp string

The date and time associated with the value of this data point. Format defined by RFC3339. Example: 2019-02-01T01:02:29.600Z

value number

Numeric value of the metric. Example: 10.4

timestamp str

The date and time associated with the value of this data point. Format defined by RFC3339. Example: 2019-02-01T01:02:29.600Z

value float

Numeric value of the metric. Example: 10.4

timestamp String

The date and time associated with the value of this data point. Format defined by RFC3339. Example: 2019-02-01T01:02:29.600Z

value Number

Numeric value of the metric. Example: 10.4

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.