1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. getCesMetricsV1
opentelekomcloud 1.36.43 published on Thursday, Jul 17, 2025 by opentelekomcloud

opentelekomcloud.getCesMetricsV1

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.43 published on Thursday, Jul 17, 2025 by opentelekomcloud

    Up-to-date reference of API arguments for CES metrics v1 you can get at documentation portal

    Get details about CES metrics within OpenTelekomCloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as opentelekomcloud from "@pulumi/opentelekomcloud";
    
    const metrics1 = opentelekomcloud.getCesMetricsV1({
        metricName: "cpu_util",
        namespace: "SYS.ECS",
    });
    
    import pulumi
    import pulumi_opentelekomcloud as opentelekomcloud
    
    metrics1 = opentelekomcloud.get_ces_metrics_v1(metric_name="cpu_util",
        namespace="SYS.ECS")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := opentelekomcloud.GetCesMetricsV1(ctx, &opentelekomcloud.GetCesMetricsV1Args{
    			MetricName: pulumi.StringRef("cpu_util"),
    			Namespace:  pulumi.StringRef("SYS.ECS"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opentelekomcloud = Pulumi.Opentelekomcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var metrics1 = Opentelekomcloud.GetCesMetricsV1.Invoke(new()
        {
            MetricName = "cpu_util",
            Namespace = "SYS.ECS",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.OpentelekomcloudFunctions;
    import com.pulumi.opentelekomcloud.inputs.GetCesMetricsV1Args;
    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 metrics1 = OpentelekomcloudFunctions.getCesMetricsV1(GetCesMetricsV1Args.builder()
                .metricName("cpu_util")
                .namespace("SYS.ECS")
                .build());
    
        }
    }
    
    variables:
      metrics1:
        fn::invoke:
          function: opentelekomcloud:getCesMetricsV1
          arguments:
            metricName: cpu_util
            namespace: SYS.ECS
    

    Using getCesMetricsV1

    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 getCesMetricsV1(args: GetCesMetricsV1Args, opts?: InvokeOptions): Promise<GetCesMetricsV1Result>
    function getCesMetricsV1Output(args: GetCesMetricsV1OutputArgs, opts?: InvokeOptions): Output<GetCesMetricsV1Result>
    def get_ces_metrics_v1(dim: Optional[str] = None,
                           id: Optional[str] = None,
                           limit: Optional[float] = None,
                           metric_name: Optional[str] = None,
                           namespace: Optional[str] = None,
                           order: Optional[str] = None,
                           start: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetCesMetricsV1Result
    def get_ces_metrics_v1_output(dim: Optional[pulumi.Input[str]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           limit: Optional[pulumi.Input[float]] = None,
                           metric_name: Optional[pulumi.Input[str]] = None,
                           namespace: Optional[pulumi.Input[str]] = None,
                           order: Optional[pulumi.Input[str]] = None,
                           start: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetCesMetricsV1Result]
    func GetCesMetricsV1(ctx *Context, args *GetCesMetricsV1Args, opts ...InvokeOption) (*GetCesMetricsV1Result, error)
    func GetCesMetricsV1Output(ctx *Context, args *GetCesMetricsV1OutputArgs, opts ...InvokeOption) GetCesMetricsV1ResultOutput

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

    public static class GetCesMetricsV1 
    {
        public static Task<GetCesMetricsV1Result> InvokeAsync(GetCesMetricsV1Args args, InvokeOptions? opts = null)
        public static Output<GetCesMetricsV1Result> Invoke(GetCesMetricsV1InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCesMetricsV1Result> getCesMetricsV1(GetCesMetricsV1Args args, InvokeOptions options)
    public static Output<GetCesMetricsV1Result> getCesMetricsV1(GetCesMetricsV1Args args, InvokeOptions options)
    
    fn::invoke:
      function: opentelekomcloud:index/getCesMetricsV1:getCesMetricsV1
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Dim string
    Specifies the dimension. A maximum of three dimensions are supported, and the dimensions are numbered from 0 in dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters. Single dimension: dim.0=instance_id,xxxx-xxxx-xxxx, Multiple dimensions: dim.0=key,value&dim.1=key,value
    Id string
    Limit double
    Specifies the maximum number of records that can be queried at a time. Supported range: 1 to 1000 (default)
    MetricName string
    Specifies the metric ID.
    Namespace string
    Specifies the namespace of a service.
    Order string

    Specifies the result sorting method, which is sorted by timestamp. The default method is desc. Supported values: asc: The query results are displayed in the ascending order. desc: The query results are displayed in the descending order.

    NOTE: namespaces and dimensions are available on our github link or official documentation.

    Start string
    Specifies the paging start value. The format is namespace.metric_name.key:value. Example: start=SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d.
    Dim string
    Specifies the dimension. A maximum of three dimensions are supported, and the dimensions are numbered from 0 in dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters. Single dimension: dim.0=instance_id,xxxx-xxxx-xxxx, Multiple dimensions: dim.0=key,value&dim.1=key,value
    Id string
    Limit float64
    Specifies the maximum number of records that can be queried at a time. Supported range: 1 to 1000 (default)
    MetricName string
    Specifies the metric ID.
    Namespace string
    Specifies the namespace of a service.
    Order string

    Specifies the result sorting method, which is sorted by timestamp. The default method is desc. Supported values: asc: The query results are displayed in the ascending order. desc: The query results are displayed in the descending order.

    NOTE: namespaces and dimensions are available on our github link or official documentation.

    Start string
    Specifies the paging start value. The format is namespace.metric_name.key:value. Example: start=SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d.
    dim String
    Specifies the dimension. A maximum of three dimensions are supported, and the dimensions are numbered from 0 in dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters. Single dimension: dim.0=instance_id,xxxx-xxxx-xxxx, Multiple dimensions: dim.0=key,value&dim.1=key,value
    id String
    limit Double
    Specifies the maximum number of records that can be queried at a time. Supported range: 1 to 1000 (default)
    metricName String
    Specifies the metric ID.
    namespace String
    Specifies the namespace of a service.
    order String

    Specifies the result sorting method, which is sorted by timestamp. The default method is desc. Supported values: asc: The query results are displayed in the ascending order. desc: The query results are displayed in the descending order.

    NOTE: namespaces and dimensions are available on our github link or official documentation.

    start String
    Specifies the paging start value. The format is namespace.metric_name.key:value. Example: start=SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d.
    dim string
    Specifies the dimension. A maximum of three dimensions are supported, and the dimensions are numbered from 0 in dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters. Single dimension: dim.0=instance_id,xxxx-xxxx-xxxx, Multiple dimensions: dim.0=key,value&dim.1=key,value
    id string
    limit number
    Specifies the maximum number of records that can be queried at a time. Supported range: 1 to 1000 (default)
    metricName string
    Specifies the metric ID.
    namespace string
    Specifies the namespace of a service.
    order string

    Specifies the result sorting method, which is sorted by timestamp. The default method is desc. Supported values: asc: The query results are displayed in the ascending order. desc: The query results are displayed in the descending order.

    NOTE: namespaces and dimensions are available on our github link or official documentation.

    start string
    Specifies the paging start value. The format is namespace.metric_name.key:value. Example: start=SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d.
    dim str
    Specifies the dimension. A maximum of three dimensions are supported, and the dimensions are numbered from 0 in dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters. Single dimension: dim.0=instance_id,xxxx-xxxx-xxxx, Multiple dimensions: dim.0=key,value&dim.1=key,value
    id str
    limit float
    Specifies the maximum number of records that can be queried at a time. Supported range: 1 to 1000 (default)
    metric_name str
    Specifies the metric ID.
    namespace str
    Specifies the namespace of a service.
    order str

    Specifies the result sorting method, which is sorted by timestamp. The default method is desc. Supported values: asc: The query results are displayed in the ascending order. desc: The query results are displayed in the descending order.

    NOTE: namespaces and dimensions are available on our github link or official documentation.

    start str
    Specifies the paging start value. The format is namespace.metric_name.key:value. Example: start=SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d.
    dim String
    Specifies the dimension. A maximum of three dimensions are supported, and the dimensions are numbered from 0 in dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters. Single dimension: dim.0=instance_id,xxxx-xxxx-xxxx, Multiple dimensions: dim.0=key,value&dim.1=key,value
    id String
    limit Number
    Specifies the maximum number of records that can be queried at a time. Supported range: 1 to 1000 (default)
    metricName String
    Specifies the metric ID.
    namespace String
    Specifies the namespace of a service.
    order String

    Specifies the result sorting method, which is sorted by timestamp. The default method is desc. Supported values: asc: The query results are displayed in the ascending order. desc: The query results are displayed in the descending order.

    NOTE: namespaces and dimensions are available on our github link or official documentation.

    start String
    Specifies the paging start value. The format is namespace.metric_name.key:value. Example: start=SYS.ECS.cpu_util.instance_id:d9112af5-6913-4f3b-bd0a-3f96711e004d.

    getCesMetricsV1 Result

    The following output properties are available:

    Id string
    MetaDatas List<GetCesMetricsV1MetaData>
    Specifies the metadata of query results, including the pagination information. The structure is described below.
    Metrics List<GetCesMetricsV1Metric>
    Specifies the list of metric objects. The structure is described below.
    Dim string
    Limit double
    MetricName string
    Specifies the metric name, such as cpu_util.
    Namespace string
    Specifies the metric namespace.
    Order string
    Start string
    Id string
    MetaDatas []GetCesMetricsV1MetaData
    Specifies the metadata of query results, including the pagination information. The structure is described below.
    Metrics []GetCesMetricsV1Metric
    Specifies the list of metric objects. The structure is described below.
    Dim string
    Limit float64
    MetricName string
    Specifies the metric name, such as cpu_util.
    Namespace string
    Specifies the metric namespace.
    Order string
    Start string
    id String
    metaDatas List<GetCesMetricsV1MetaData>
    Specifies the metadata of query results, including the pagination information. The structure is described below.
    metrics List<GetCesMetricsV1Metric>
    Specifies the list of metric objects. The structure is described below.
    dim String
    limit Double
    metricName String
    Specifies the metric name, such as cpu_util.
    namespace String
    Specifies the metric namespace.
    order String
    start String
    id string
    metaDatas GetCesMetricsV1MetaData[]
    Specifies the metadata of query results, including the pagination information. The structure is described below.
    metrics GetCesMetricsV1Metric[]
    Specifies the list of metric objects. The structure is described below.
    dim string
    limit number
    metricName string
    Specifies the metric name, such as cpu_util.
    namespace string
    Specifies the metric namespace.
    order string
    start string
    id str
    meta_datas Sequence[GetCesMetricsV1MetaData]
    Specifies the metadata of query results, including the pagination information. The structure is described below.
    metrics Sequence[GetCesMetricsV1Metric]
    Specifies the list of metric objects. The structure is described below.
    dim str
    limit float
    metric_name str
    Specifies the metric name, such as cpu_util.
    namespace str
    Specifies the metric namespace.
    order str
    start str
    id String
    metaDatas List<Property Map>
    Specifies the metadata of query results, including the pagination information. The structure is described below.
    metrics List<Property Map>
    Specifies the list of metric objects. The structure is described below.
    dim String
    limit Number
    metricName String
    Specifies the metric name, such as cpu_util.
    namespace String
    Specifies the metric namespace.
    order String
    start String

    Supporting Types

    GetCesMetricsV1MetaData

    Count double
    Specifies the number of returned results.
    Marker string
    Specifies the pagination marker.
    Total double
    Specifies the total number of metrics.
    Count float64
    Specifies the number of returned results.
    Marker string
    Specifies the pagination marker.
    Total float64
    Specifies the total number of metrics.
    count Double
    Specifies the number of returned results.
    marker String
    Specifies the pagination marker.
    total Double
    Specifies the total number of metrics.
    count number
    Specifies the number of returned results.
    marker string
    Specifies the pagination marker.
    total number
    Specifies the total number of metrics.
    count float
    Specifies the number of returned results.
    marker str
    Specifies the pagination marker.
    total float
    Specifies the total number of metrics.
    count Number
    Specifies the number of returned results.
    marker String
    Specifies the pagination marker.
    total Number
    Specifies the total number of metrics.

    GetCesMetricsV1Metric

    Dimensions List<GetCesMetricsV1MetricDimension>
    Specifies the list of metric dimensions. The structure is described below.
    MetricName string
    Specifies the metric ID.
    Namespace string
    Specifies the namespace of a service.
    Unit string
    Specifies the metric unit.
    Dimensions []GetCesMetricsV1MetricDimension
    Specifies the list of metric dimensions. The structure is described below.
    MetricName string
    Specifies the metric ID.
    Namespace string
    Specifies the namespace of a service.
    Unit string
    Specifies the metric unit.
    dimensions List<GetCesMetricsV1MetricDimension>
    Specifies the list of metric dimensions. The structure is described below.
    metricName String
    Specifies the metric ID.
    namespace String
    Specifies the namespace of a service.
    unit String
    Specifies the metric unit.
    dimensions GetCesMetricsV1MetricDimension[]
    Specifies the list of metric dimensions. The structure is described below.
    metricName string
    Specifies the metric ID.
    namespace string
    Specifies the namespace of a service.
    unit string
    Specifies the metric unit.
    dimensions Sequence[GetCesMetricsV1MetricDimension]
    Specifies the list of metric dimensions. The structure is described below.
    metric_name str
    Specifies the metric ID.
    namespace str
    Specifies the namespace of a service.
    unit str
    Specifies the metric unit.
    dimensions List<Property Map>
    Specifies the list of metric dimensions. The structure is described below.
    metricName String
    Specifies the metric ID.
    namespace String
    Specifies the namespace of a service.
    unit String
    Specifies the metric unit.

    GetCesMetricsV1MetricDimension

    Name string
    Specifies the dimension name.
    Value string
    Specifies the dimension value.
    Name string
    Specifies the dimension name.
    Value string
    Specifies the dimension value.
    name String
    Specifies the dimension name.
    value String
    Specifies the dimension value.
    name string
    Specifies the dimension name.
    value string
    Specifies the dimension value.
    name str
    Specifies the dimension name.
    value str
    Specifies the dimension value.
    name String
    Specifies the dimension name.
    value String
    Specifies the dimension value.

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.43 published on Thursday, Jul 17, 2025 by opentelekomcloud