Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getMonitorData
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getMonitorData

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this data source to query monitor data. for complex queries, use (https://github.com/tencentyun/tencentcloud-exporter)

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const instances = tencentcloud.getInstances({});
const cvmMonitorData = instances.then(instances => tencentcloud.getMonitorData({
    namespace: "QCE/CVM",
    metricName: "CPUUsage",
    dimensions: [{
        name: "InstanceId",
        value: instances.instanceLists?.[0]?.instanceId,
    }],
    period: 300,
    startTime: "2020-04-28T18:45:00+08:00",
    endTime: "2020-04-28T19:00:00+08:00",
}));
const cosMonitorData = tencentcloud.getMonitorData({
    namespace: "QCE/COS",
    metricName: "InternetTraffic",
    dimensions: [
        {
            name: "appid",
            value: "1258798060",
        },
        {
            name: "bucket",
            value: "test-1258798060",
        },
    ],
    period: 300,
    startTime: "2020-04-28T18:30:00+08:00",
    endTime: "2020-04-28T19:00:00+08:00",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

instances = tencentcloud.get_instances()
cvm_monitor_data = tencentcloud.get_monitor_data(namespace="QCE/CVM",
    metric_name="CPUUsage",
    dimensions=[{
        "name": "InstanceId",
        "value": instances.instance_lists[0].instance_id,
    }],
    period=300,
    start_time="2020-04-28T18:45:00+08:00",
    end_time="2020-04-28T19:00:00+08:00")
cos_monitor_data = tencentcloud.get_monitor_data(namespace="QCE/COS",
    metric_name="InternetTraffic",
    dimensions=[
        {
            "name": "appid",
            "value": "1258798060",
        },
        {
            "name": "bucket",
            "value": "test-1258798060",
        },
    ],
    period=300,
    start_time="2020-04-28T18:30:00+08:00",
    end_time="2020-04-28T19:00:00+08:00")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instances, err := tencentcloud.GetInstances(ctx, &tencentcloud.GetInstancesArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = tencentcloud.GetMonitorData(ctx, &tencentcloud.GetMonitorDataArgs{
			Namespace:  "QCE/CVM",
			MetricName: "CPUUsage",
			Dimensions: []tencentcloud.GetMonitorDataDimension{
				{
					Name:  "InstanceId",
					Value: instances.InstanceLists[0].InstanceId,
				},
			},
			Period:    pulumi.Float64Ref(300),
			StartTime: "2020-04-28T18:45:00+08:00",
			EndTime:   "2020-04-28T19:00:00+08:00",
		}, nil)
		if err != nil {
			return err
		}
		_, err = tencentcloud.GetMonitorData(ctx, &tencentcloud.GetMonitorDataArgs{
			Namespace:  "QCE/COS",
			MetricName: "InternetTraffic",
			Dimensions: []tencentcloud.GetMonitorDataDimension{
				{
					Name:  "appid",
					Value: "1258798060",
				},
				{
					Name:  "bucket",
					Value: "test-1258798060",
				},
			},
			Period:    pulumi.Float64Ref(300),
			StartTime: "2020-04-28T18:30:00+08:00",
			EndTime:   "2020-04-28T19:00:00+08:00",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var instances = Tencentcloud.GetInstances.Invoke();

    var cvmMonitorData = Tencentcloud.GetMonitorData.Invoke(new()
    {
        Namespace = "QCE/CVM",
        MetricName = "CPUUsage",
        Dimensions = new[]
        {
            new Tencentcloud.Inputs.GetMonitorDataDimensionInputArgs
            {
                Name = "InstanceId",
                Value = instances.Apply(getInstancesResult => getInstancesResult.InstanceLists[0]?.InstanceId),
            },
        },
        Period = 300,
        StartTime = "2020-04-28T18:45:00+08:00",
        EndTime = "2020-04-28T19:00:00+08:00",
    });

    var cosMonitorData = Tencentcloud.GetMonitorData.Invoke(new()
    {
        Namespace = "QCE/COS",
        MetricName = "InternetTraffic",
        Dimensions = new[]
        {
            new Tencentcloud.Inputs.GetMonitorDataDimensionInputArgs
            {
                Name = "appid",
                Value = "1258798060",
            },
            new Tencentcloud.Inputs.GetMonitorDataDimensionInputArgs
            {
                Name = "bucket",
                Value = "test-1258798060",
            },
        },
        Period = 300,
        StartTime = "2020-04-28T18:30:00+08:00",
        EndTime = "2020-04-28T19:00:00+08:00",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetInstancesArgs;
import com.pulumi.tencentcloud.inputs.GetMonitorDataArgs;
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 instances = TencentcloudFunctions.getInstances();

        final var cvmMonitorData = TencentcloudFunctions.getMonitorData(GetMonitorDataArgs.builder()
            .namespace("QCE/CVM")
            .metricName("CPUUsage")
            .dimensions(GetMonitorDataDimensionArgs.builder()
                .name("InstanceId")
                .value(instances.applyValue(getInstancesResult -> getInstancesResult.instanceLists()[0].instanceId()))
                .build())
            .period(300)
            .startTime("2020-04-28T18:45:00+08:00")
            .endTime("2020-04-28T19:00:00+08:00")
            .build());

        final var cosMonitorData = TencentcloudFunctions.getMonitorData(GetMonitorDataArgs.builder()
            .namespace("QCE/COS")
            .metricName("InternetTraffic")
            .dimensions(            
                GetMonitorDataDimensionArgs.builder()
                    .name("appid")
                    .value("1258798060")
                    .build(),
                GetMonitorDataDimensionArgs.builder()
                    .name("bucket")
                    .value("test-1258798060")
                    .build())
            .period(300)
            .startTime("2020-04-28T18:30:00+08:00")
            .endTime("2020-04-28T19:00:00+08:00")
            .build());

    }
}

    variables:
  instances:
    fn::invoke:
      function: tencentcloud:getInstances
      arguments: {}
  cvmMonitorData:
    fn::invoke:
      function: tencentcloud:getMonitorData
      arguments:
        namespace: QCE/CVM
        metricName: CPUUsage
        dimensions:
          - name: InstanceId
            value: ${instances.instanceLists[0].instanceId}
        period: 300
        startTime: 2020-04-28T18:45:00+08:00
        endTime: 2020-04-28T19:00:00+08:00
  cosMonitorData:
    fn::invoke:
      function: tencentcloud:getMonitorData
      arguments:
        namespace: QCE/COS
        metricName: InternetTraffic
        dimensions:
          - name: appid
            value: '1258798060'
          - name: bucket
            value: test-1258798060
        period: 300
        startTime: 2020-04-28T18:30:00+08:00
        endTime: 2020-04-28T19:00:00+08:00

    Using getMonitorData

    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 getMonitorData(args: GetMonitorDataArgs, opts?: InvokeOptions): Promise<GetMonitorDataResult>
function getMonitorDataOutput(args: GetMonitorDataOutputArgs, opts?: InvokeOptions): Output<GetMonitorDataResult>
    def get_monitor_data(dimensions: Optional[Sequence[GetMonitorDataDimension]] = None,
                     end_time: Optional[str] = None,
                     id: Optional[str] = None,
                     metric_name: Optional[str] = None,
                     namespace: Optional[str] = None,
                     period: Optional[float] = None,
                     result_output_file: Optional[str] = None,
                     start_time: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetMonitorDataResult
def get_monitor_data_output(dimensions: Optional[pulumi.Input[Sequence[pulumi.Input[GetMonitorDataDimensionArgs]]]] = None,
                     end_time: Optional[pulumi.Input[str]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     metric_name: Optional[pulumi.Input[str]] = None,
                     namespace: Optional[pulumi.Input[str]] = None,
                     period: Optional[pulumi.Input[float]] = None,
                     result_output_file: Optional[pulumi.Input[str]] = None,
                     start_time: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetMonitorDataResult]
    func GetMonitorData(ctx *Context, args *GetMonitorDataArgs, opts ...InvokeOption) (*GetMonitorDataResult, error)
func GetMonitorDataOutput(ctx *Context, args *GetMonitorDataOutputArgs, opts ...InvokeOption) GetMonitorDataResultOutput

    > Note: This function is named GetMonitorData in the Go SDK.

    public static class GetMonitorData 
{
    public static Task<GetMonitorDataResult> InvokeAsync(GetMonitorDataArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitorDataResult> Invoke(GetMonitorDataInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMonitorDataResult> getMonitorData(GetMonitorDataArgs args, InvokeOptions options)
public static Output<GetMonitorDataResult> getMonitorData(GetMonitorDataArgs args, InvokeOptions options)

    fn::invoke:
  function: tencentcloud:index/getMonitorData:getMonitorData
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Dimensions List<GetMonitorDataDimension>
    Dimensional composition of instance objects.
    EndTime string
    End time for this query, eg:2018-09-22T20:00:00+08:00.
    MetricName string
    Metric name, please refer to the documentation of monitor interface of each product.
    Namespace string
    Namespace of each cloud product in monitor system, refer to data.tencentcloud_monitor_product_namespace.
    StartTime string
    Start time for this query, eg:2018-09-22T19:51:23+08:00.
    Id string
    Period double
    Statistical period.
    ResultOutputFile string
    Used to store results.
    Dimensions []GetMonitorDataDimension
    Dimensional composition of instance objects.
    EndTime string
    End time for this query, eg:2018-09-22T20:00:00+08:00.
    MetricName string
    Metric name, please refer to the documentation of monitor interface of each product.
    Namespace string
    Namespace of each cloud product in monitor system, refer to data.tencentcloud_monitor_product_namespace.
    StartTime string
    Start time for this query, eg:2018-09-22T19:51:23+08:00.
    Id string
    Period float64
    Statistical period.
    ResultOutputFile string
    Used to store results.
    dimensions List<GetMonitorDataDimension>
    Dimensional composition of instance objects.
    endTime String
    End time for this query, eg:2018-09-22T20:00:00+08:00.
    metricName String
    Metric name, please refer to the documentation of monitor interface of each product.
    namespace String
    Namespace of each cloud product in monitor system, refer to data.tencentcloud_monitor_product_namespace.
    startTime String
    Start time for this query, eg:2018-09-22T19:51:23+08:00.
    id String
    period Double
    Statistical period.
    resultOutputFile String
    Used to store results.
    dimensions GetMonitorDataDimension[]
    Dimensional composition of instance objects.
    endTime string
    End time for this query, eg:2018-09-22T20:00:00+08:00.
    metricName string
    Metric name, please refer to the documentation of monitor interface of each product.
    namespace string
    Namespace of each cloud product in monitor system, refer to data.tencentcloud_monitor_product_namespace.
    startTime string
    Start time for this query, eg:2018-09-22T19:51:23+08:00.
    id string
    period number
    Statistical period.
    resultOutputFile string
    Used to store results.
    dimensions Sequence[GetMonitorDataDimension]
    Dimensional composition of instance objects.
    end_time str
    End time for this query, eg:2018-09-22T20:00:00+08:00.
    metric_name str
    Metric name, please refer to the documentation of monitor interface of each product.
    namespace str
    Namespace of each cloud product in monitor system, refer to data.tencentcloud_monitor_product_namespace.
    start_time str
    Start time for this query, eg:2018-09-22T19:51:23+08:00.
    id str
    period float
    Statistical period.
    result_output_file str
    Used to store results.
    dimensions List<Property Map>
    Dimensional composition of instance objects.
    endTime String
    End time for this query, eg:2018-09-22T20:00:00+08:00.
    metricName String
    Metric name, please refer to the documentation of monitor interface of each product.
    namespace String
    Namespace of each cloud product in monitor system, refer to data.tencentcloud_monitor_product_namespace.
    startTime String
    Start time for this query, eg:2018-09-22T19:51:23+08:00.
    id String
    period Number
    Statistical period.
    resultOutputFile String
    Used to store results.

    getMonitorData Result

    The following output properties are available:

    Dimensions List<GetMonitorDataDimension>
    EndTime string
    Id string
    Lists List<GetMonitorDataList>
    A list data point. Each element contains the following attributes:
    MetricName string
    Namespace string
    StartTime string
    Period double
    ResultOutputFile string
    Dimensions []GetMonitorDataDimension
    EndTime string
    Id string
    Lists []GetMonitorDataList
    A list data point. Each element contains the following attributes:
    MetricName string
    Namespace string
    StartTime string
    Period float64
    ResultOutputFile string
    dimensions List<GetMonitorDataDimension>
    endTime String
    id String
    lists List<GetMonitorDataList>
    A list data point. Each element contains the following attributes:
    metricName String
    namespace String
    startTime String
    period Double
    resultOutputFile String
    dimensions GetMonitorDataDimension[]
    endTime string
    id string
    lists GetMonitorDataList[]
    A list data point. Each element contains the following attributes:
    metricName string
    namespace string
    startTime string
    period number
    resultOutputFile string
    dimensions Sequence[GetMonitorDataDimension]
    end_time str
    id str
    lists Sequence[GetMonitorDataList]
    A list data point. Each element contains the following attributes:
    metric_name str
    namespace str
    start_time str
    period float
    result_output_file str
    dimensions List<Property Map>
    endTime String
    id String
    lists List<Property Map>
    A list data point. Each element contains the following attributes:
    metricName String
    namespace String
    startTime String
    period Number
    resultOutputFile String

    Supporting Types

    GetMonitorDataDimension

    Name string
    Instance dimension name, eg: InstanceId for cvm.
    Value string
    Instance dimension value, eg: ins-j0hk02zo for cvm.
    Name string
    Instance dimension name, eg: InstanceId for cvm.
    Value string
    Instance dimension value, eg: ins-j0hk02zo for cvm.
    name String
    Instance dimension name, eg: InstanceId for cvm.
    value String
    Instance dimension value, eg: ins-j0hk02zo for cvm.
    name string
    Instance dimension name, eg: InstanceId for cvm.
    value string
    Instance dimension value, eg: ins-j0hk02zo for cvm.
    name str
    Instance dimension name, eg: InstanceId for cvm.
    value str
    Instance dimension value, eg: ins-j0hk02zo for cvm.
    name String
    Instance dimension name, eg: InstanceId for cvm.
    value String
    Instance dimension value, eg: ins-j0hk02zo for cvm.

    GetMonitorDataList

    Timestamp double
    Statistical timestamp.
    Value double
    Statistical value.
    Timestamp float64
    Statistical timestamp.
    Value float64
    Statistical value.
    timestamp Double
    Statistical timestamp.
    value Double
    Statistical value.
    timestamp number
    Statistical timestamp.
    value number
    Statistical value.
    timestamp float
    Statistical timestamp.
    value float
    Statistical value.
    timestamp Number
    Statistical timestamp.
    value Number
    Statistical value.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud