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

tencentcloud.ClsAlarm

Explore with Pulumi AI

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

    Provides a resource to create a cls alarm

    Example Usage

    Use single condition

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

const example = new tencentcloud.ClsAlarm("example", {
    alarmLevel: 1,
    alarmNoticeIds: ["notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101"],
    alarmPeriod: 15,
    alarmTargets: [{
        endTimeOffset: 0,
        logsetId: "e74efb8e-f647-48b2-a725-43f11b122081",
        number: 1,
        query: "status:>500 | select count(*) as errorCounts",
        startTimeOffset: -15,
        syntaxRule: 1,
        topicId: "59cf3ec0-1612-4157-be3f-341b2e7a53cb",
    }],
    analyses: [{
        configInfos: [{
            key: "QueryIndex",
            value: "1",
        }],
        content: "__FILENAME__",
        name: "terraform",
        type: "field",
    }],
    condition: "$1.source='10.0.0.1'",
    messageTemplate: "{{.Label}}",
    monitorTime: {
        time: 1,
        type: "Period",
    },
    status: true,
    tags: {
        createdBy: "terraform",
    },
    triggerCount: 1,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.ClsAlarm("example",
    alarm_level=1,
    alarm_notice_ids=["notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101"],
    alarm_period=15,
    alarm_targets=[{
        "end_time_offset": 0,
        "logset_id": "e74efb8e-f647-48b2-a725-43f11b122081",
        "number": 1,
        "query": "status:>500 | select count(*) as errorCounts",
        "start_time_offset": -15,
        "syntax_rule": 1,
        "topic_id": "59cf3ec0-1612-4157-be3f-341b2e7a53cb",
    }],
    analyses=[{
        "config_infos": [{
            "key": "QueryIndex",
            "value": "1",
        }],
        "content": "__FILENAME__",
        "name": "terraform",
        "type": "field",
    }],
    condition="$1.source='10.0.0.1'",
    message_template="{{.Label}}",
    monitor_time={
        "time": 1,
        "type": "Period",
    },
    status=True,
    tags={
        "createdBy": "terraform",
    },
    trigger_count=1)

    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 {
		_, err := tencentcloud.NewClsAlarm(ctx, "example", &tencentcloud.ClsAlarmArgs{
			AlarmLevel: pulumi.Float64(1),
			AlarmNoticeIds: pulumi.StringArray{
				pulumi.String("notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101"),
			},
			AlarmPeriod: pulumi.Float64(15),
			AlarmTargets: tencentcloud.ClsAlarmAlarmTargetArray{
				&tencentcloud.ClsAlarmAlarmTargetArgs{
					EndTimeOffset:   pulumi.Float64(0),
					LogsetId:        pulumi.String("e74efb8e-f647-48b2-a725-43f11b122081"),
					Number:          pulumi.Float64(1),
					Query:           pulumi.String("status:>500 | select count(*) as errorCounts"),
					StartTimeOffset: pulumi.Float64(-15),
					SyntaxRule:      pulumi.Float64(1),
					TopicId:         pulumi.String("59cf3ec0-1612-4157-be3f-341b2e7a53cb"),
				},
			},
			Analyses: tencentcloud.ClsAlarmAnalysisArray{
				&tencentcloud.ClsAlarmAnalysisArgs{
					ConfigInfos: tencentcloud.ClsAlarmAnalysisConfigInfoArray{
						&tencentcloud.ClsAlarmAnalysisConfigInfoArgs{
							Key:   pulumi.String("QueryIndex"),
							Value: pulumi.String("1"),
						},
					},
					Content: pulumi.String("__FILENAME__"),
					Name:    pulumi.String("terraform"),
					Type:    pulumi.String("field"),
				},
			},
			Condition:       pulumi.String("$1.source='10.0.0.1'"),
			MessageTemplate: pulumi.String("{{.Label}}"),
			MonitorTime: &tencentcloud.ClsAlarmMonitorTimeArgs{
				Time: pulumi.Float64(1),
				Type: pulumi.String("Period"),
			},
			Status: pulumi.Bool(true),
			Tags: pulumi.StringMap{
				"createdBy": pulumi.String("terraform"),
			},
			TriggerCount: pulumi.Float64(1),
		})
		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 example = new Tencentcloud.ClsAlarm("example", new()
    {
        AlarmLevel = 1,
        AlarmNoticeIds = new[]
        {
            "notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101",
        },
        AlarmPeriod = 15,
        AlarmTargets = new[]
        {
            new Tencentcloud.Inputs.ClsAlarmAlarmTargetArgs
            {
                EndTimeOffset = 0,
                LogsetId = "e74efb8e-f647-48b2-a725-43f11b122081",
                Number = 1,
                Query = "status:>500 | select count(*) as errorCounts",
                StartTimeOffset = -15,
                SyntaxRule = 1,
                TopicId = "59cf3ec0-1612-4157-be3f-341b2e7a53cb",
            },
        },
        Analyses = new[]
        {
            new Tencentcloud.Inputs.ClsAlarmAnalysisArgs
            {
                ConfigInfos = new[]
                {
                    new Tencentcloud.Inputs.ClsAlarmAnalysisConfigInfoArgs
                    {
                        Key = "QueryIndex",
                        Value = "1",
                    },
                },
                Content = "__FILENAME__",
                Name = "terraform",
                Type = "field",
            },
        },
        Condition = "$1.source='10.0.0.1'",
        MessageTemplate = "{{.Label}}",
        MonitorTime = new Tencentcloud.Inputs.ClsAlarmMonitorTimeArgs
        {
            Time = 1,
            Type = "Period",
        },
        Status = true,
        Tags = 
        {
            { "createdBy", "terraform" },
        },
        TriggerCount = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClsAlarm;
import com.pulumi.tencentcloud.ClsAlarmArgs;
import com.pulumi.tencentcloud.inputs.ClsAlarmAlarmTargetArgs;
import com.pulumi.tencentcloud.inputs.ClsAlarmAnalysisArgs;
import com.pulumi.tencentcloud.inputs.ClsAlarmMonitorTimeArgs;
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) {
        var example = new ClsAlarm("example", ClsAlarmArgs.builder()
            .alarmLevel(1)
            .alarmNoticeIds("notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101")
            .alarmPeriod(15)
            .alarmTargets(ClsAlarmAlarmTargetArgs.builder()
                .endTimeOffset(0)
                .logsetId("e74efb8e-f647-48b2-a725-43f11b122081")
                .number(1)
                .query("status:>500 | select count(*) as errorCounts")
                .startTimeOffset(-15)
                .syntaxRule(1)
                .topicId("59cf3ec0-1612-4157-be3f-341b2e7a53cb")
                .build())
            .analyses(ClsAlarmAnalysisArgs.builder()
                .configInfos(ClsAlarmAnalysisConfigInfoArgs.builder()
                    .key("QueryIndex")
                    .value("1")
                    .build())
                .content("__FILENAME__")
                .name("terraform")
                .type("field")
                .build())
            .condition("$1.source='10.0.0.1'")
            .messageTemplate("{{.Label}}")
            .monitorTime(ClsAlarmMonitorTimeArgs.builder()
                .time(1)
                .type("Period")
                .build())
            .status(true)
            .tags(Map.of("createdBy", "terraform"))
            .triggerCount(1)
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:ClsAlarm
    properties:
      alarmLevel: 1
      alarmNoticeIds:
        - notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101
      alarmPeriod: 15
      alarmTargets:
        - endTimeOffset: 0
          logsetId: e74efb8e-f647-48b2-a725-43f11b122081
          number: 1
          query: status:>500 | select count(*) as errorCounts
          startTimeOffset: -15
          syntaxRule: 1
          topicId: 59cf3ec0-1612-4157-be3f-341b2e7a53cb
      analyses:
        - configInfos:
            - key: QueryIndex
              value: '1'
          content: __FILENAME__
          name: terraform
          type: field
      condition: $1.source='10.0.0.1'
      messageTemplate: '{{.Label}}'
      monitorTime:
        time: 1
        type: Period
      status: true
      tags:
        createdBy: terraform
      triggerCount: 1

    Use multi conditions

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

const example = new tencentcloud.ClsAlarm("example", {
    alarmNoticeIds: ["notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101"],
    alarmPeriod: 15,
    alarmTargets: [{
        endTimeOffset: 0,
        logsetId: "e74efb8e-f647-48b2-a725-43f11b122081",
        number: 1,
        query: "status:>500 | select count(*) as errorCounts",
        startTimeOffset: -15,
        syntaxRule: 1,
        topicId: "59cf3ec0-1612-4157-be3f-341b2e7a53cb",
    }],
    analyses: [{
        configInfos: [{
            key: "QueryIndex",
            value: "1",
        }],
        content: "__FILENAME__",
        name: "terraform",
        type: "field",
    }],
    messageTemplate: "{{.Label}}",
    monitorTime: {
        time: 1,
        type: "Period",
    },
    multiConditions: [
        {
            alarmLevel: 1,
            condition: "[$1.__QUERYCOUNT__]> 0",
        },
        {
            alarmLevel: 2,
            condition: "$1.source='10.0.0.1'",
        },
    ],
    status: true,
    tags: {
        createdBy: "terraform",
    },
    triggerCount: 1,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.ClsAlarm("example",
    alarm_notice_ids=["notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101"],
    alarm_period=15,
    alarm_targets=[{
        "end_time_offset": 0,
        "logset_id": "e74efb8e-f647-48b2-a725-43f11b122081",
        "number": 1,
        "query": "status:>500 | select count(*) as errorCounts",
        "start_time_offset": -15,
        "syntax_rule": 1,
        "topic_id": "59cf3ec0-1612-4157-be3f-341b2e7a53cb",
    }],
    analyses=[{
        "config_infos": [{
            "key": "QueryIndex",
            "value": "1",
        }],
        "content": "__FILENAME__",
        "name": "terraform",
        "type": "field",
    }],
    message_template="{{.Label}}",
    monitor_time={
        "time": 1,
        "type": "Period",
    },
    multi_conditions=[
        {
            "alarm_level": 1,
            "condition": "[$1.__QUERYCOUNT__]> 0",
        },
        {
            "alarm_level": 2,
            "condition": "$1.source='10.0.0.1'",
        },
    ],
    status=True,
    tags={
        "createdBy": "terraform",
    },
    trigger_count=1)

    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 {
		_, err := tencentcloud.NewClsAlarm(ctx, "example", &tencentcloud.ClsAlarmArgs{
			AlarmNoticeIds: pulumi.StringArray{
				pulumi.String("notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101"),
			},
			AlarmPeriod: pulumi.Float64(15),
			AlarmTargets: tencentcloud.ClsAlarmAlarmTargetArray{
				&tencentcloud.ClsAlarmAlarmTargetArgs{
					EndTimeOffset:   pulumi.Float64(0),
					LogsetId:        pulumi.String("e74efb8e-f647-48b2-a725-43f11b122081"),
					Number:          pulumi.Float64(1),
					Query:           pulumi.String("status:>500 | select count(*) as errorCounts"),
					StartTimeOffset: pulumi.Float64(-15),
					SyntaxRule:      pulumi.Float64(1),
					TopicId:         pulumi.String("59cf3ec0-1612-4157-be3f-341b2e7a53cb"),
				},
			},
			Analyses: tencentcloud.ClsAlarmAnalysisArray{
				&tencentcloud.ClsAlarmAnalysisArgs{
					ConfigInfos: tencentcloud.ClsAlarmAnalysisConfigInfoArray{
						&tencentcloud.ClsAlarmAnalysisConfigInfoArgs{
							Key:   pulumi.String("QueryIndex"),
							Value: pulumi.String("1"),
						},
					},
					Content: pulumi.String("__FILENAME__"),
					Name:    pulumi.String("terraform"),
					Type:    pulumi.String("field"),
				},
			},
			MessageTemplate: pulumi.String("{{.Label}}"),
			MonitorTime: &tencentcloud.ClsAlarmMonitorTimeArgs{
				Time: pulumi.Float64(1),
				Type: pulumi.String("Period"),
			},
			MultiConditions: tencentcloud.ClsAlarmMultiConditionArray{
				&tencentcloud.ClsAlarmMultiConditionArgs{
					AlarmLevel: pulumi.Float64(1),
					Condition:  pulumi.String("[$1.__QUERYCOUNT__]> 0"),
				},
				&tencentcloud.ClsAlarmMultiConditionArgs{
					AlarmLevel: pulumi.Float64(2),
					Condition:  pulumi.String("$1.source='10.0.0.1'"),
				},
			},
			Status: pulumi.Bool(true),
			Tags: pulumi.StringMap{
				"createdBy": pulumi.String("terraform"),
			},
			TriggerCount: pulumi.Float64(1),
		})
		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 example = new Tencentcloud.ClsAlarm("example", new()
    {
        AlarmNoticeIds = new[]
        {
            "notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101",
        },
        AlarmPeriod = 15,
        AlarmTargets = new[]
        {
            new Tencentcloud.Inputs.ClsAlarmAlarmTargetArgs
            {
                EndTimeOffset = 0,
                LogsetId = "e74efb8e-f647-48b2-a725-43f11b122081",
                Number = 1,
                Query = "status:>500 | select count(*) as errorCounts",
                StartTimeOffset = -15,
                SyntaxRule = 1,
                TopicId = "59cf3ec0-1612-4157-be3f-341b2e7a53cb",
            },
        },
        Analyses = new[]
        {
            new Tencentcloud.Inputs.ClsAlarmAnalysisArgs
            {
                ConfigInfos = new[]
                {
                    new Tencentcloud.Inputs.ClsAlarmAnalysisConfigInfoArgs
                    {
                        Key = "QueryIndex",
                        Value = "1",
                    },
                },
                Content = "__FILENAME__",
                Name = "terraform",
                Type = "field",
            },
        },
        MessageTemplate = "{{.Label}}",
        MonitorTime = new Tencentcloud.Inputs.ClsAlarmMonitorTimeArgs
        {
            Time = 1,
            Type = "Period",
        },
        MultiConditions = new[]
        {
            new Tencentcloud.Inputs.ClsAlarmMultiConditionArgs
            {
                AlarmLevel = 1,
                Condition = "[$1.__QUERYCOUNT__]> 0",
            },
            new Tencentcloud.Inputs.ClsAlarmMultiConditionArgs
            {
                AlarmLevel = 2,
                Condition = "$1.source='10.0.0.1'",
            },
        },
        Status = true,
        Tags = 
        {
            { "createdBy", "terraform" },
        },
        TriggerCount = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClsAlarm;
import com.pulumi.tencentcloud.ClsAlarmArgs;
import com.pulumi.tencentcloud.inputs.ClsAlarmAlarmTargetArgs;
import com.pulumi.tencentcloud.inputs.ClsAlarmAnalysisArgs;
import com.pulumi.tencentcloud.inputs.ClsAlarmMonitorTimeArgs;
import com.pulumi.tencentcloud.inputs.ClsAlarmMultiConditionArgs;
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) {
        var example = new ClsAlarm("example", ClsAlarmArgs.builder()
            .alarmNoticeIds("notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101")
            .alarmPeriod(15)
            .alarmTargets(ClsAlarmAlarmTargetArgs.builder()
                .endTimeOffset(0)
                .logsetId("e74efb8e-f647-48b2-a725-43f11b122081")
                .number(1)
                .query("status:>500 | select count(*) as errorCounts")
                .startTimeOffset(-15)
                .syntaxRule(1)
                .topicId("59cf3ec0-1612-4157-be3f-341b2e7a53cb")
                .build())
            .analyses(ClsAlarmAnalysisArgs.builder()
                .configInfos(ClsAlarmAnalysisConfigInfoArgs.builder()
                    .key("QueryIndex")
                    .value("1")
                    .build())
                .content("__FILENAME__")
                .name("terraform")
                .type("field")
                .build())
            .messageTemplate("{{.Label}}")
            .monitorTime(ClsAlarmMonitorTimeArgs.builder()
                .time(1)
                .type("Period")
                .build())
            .multiConditions(            
                ClsAlarmMultiConditionArgs.builder()
                    .alarmLevel(1)
                    .condition("[$1.__QUERYCOUNT__]> 0")
                    .build(),
                ClsAlarmMultiConditionArgs.builder()
                    .alarmLevel(2)
                    .condition("$1.source='10.0.0.1'")
                    .build())
            .status(true)
            .tags(Map.of("createdBy", "terraform"))
            .triggerCount(1)
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:ClsAlarm
    properties:
      alarmNoticeIds:
        - notice-c2af43ee-1a4b-4c4a-ae3e-f81481280101
      alarmPeriod: 15
      alarmTargets:
        - endTimeOffset: 0
          logsetId: e74efb8e-f647-48b2-a725-43f11b122081
          number: 1
          query: status:>500 | select count(*) as errorCounts
          startTimeOffset: -15
          syntaxRule: 1
          topicId: 59cf3ec0-1612-4157-be3f-341b2e7a53cb
      analyses:
        - configInfos:
            - key: QueryIndex
              value: '1'
          content: __FILENAME__
          name: terraform
          type: field
      messageTemplate: '{{.Label}}'
      monitorTime:
        time: 1
        type: Period
      multiConditions:
        - alarmLevel: 1
          condition: '[$1.__QUERYCOUNT__]> 0'
        - alarmLevel: 2
          condition: $1.source='10.0.0.1'
      status: true
      tags:
        createdBy: terraform
      triggerCount: 1

    Create ClsAlarm Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClsAlarm(name: string, args: ClsAlarmArgs, opts?: CustomResourceOptions);
    @overload
def ClsAlarm(resource_name: str,
             args: ClsAlarmArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def ClsAlarm(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             monitor_time: Optional[ClsAlarmMonitorTimeArgs] = None,
             alarm_notice_ids: Optional[Sequence[str]] = None,
             alarm_period: Optional[float] = None,
             alarm_targets: Optional[Sequence[ClsAlarmAlarmTargetArgs]] = None,
             trigger_count: Optional[float] = None,
             multi_conditions: Optional[Sequence[ClsAlarmMultiConditionArgs]] = None,
             call_back: Optional[ClsAlarmCallBackArgs] = None,
             message_template: Optional[str] = None,
             cls_alarm_id: Optional[str] = None,
             alarm_level: Optional[float] = None,
             condition: Optional[str] = None,
             name: Optional[str] = None,
             status: Optional[bool] = None,
             tags: Optional[Mapping[str, str]] = None,
             analyses: Optional[Sequence[ClsAlarmAnalysisArgs]] = None)
    func NewClsAlarm(ctx *Context, name string, args ClsAlarmArgs, opts ...ResourceOption) (*ClsAlarm, error)
    public ClsAlarm(string name, ClsAlarmArgs args, CustomResourceOptions? opts = null)
    public ClsAlarm(String name, ClsAlarmArgs args)
public ClsAlarm(String name, ClsAlarmArgs args, CustomResourceOptions options)

    type: tencentcloud:ClsAlarm
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClsAlarmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClsAlarmArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClsAlarmArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClsAlarmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClsAlarmArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ClsAlarm Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ClsAlarm resource accepts the following input properties:

    AlarmNoticeIds List<string>
    list of alarm notice id.
    AlarmPeriod double
    alarm repeat cycle.
    AlarmTargets List<ClsAlarmAlarmTarget>
    list of alarm target.
    MonitorTime ClsAlarmMonitorTime
    monitor task execution time.
    TriggerCount double
    continuous cycle.
    AlarmLevel double
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    Analyses List<ClsAlarmAnalysis>
    multidimensional analysis.
    CallBack ClsAlarmCallBack
    user define callback.
    ClsAlarmId string
    ID of the resource.
    Condition string
    Trigger condition.
    MessageTemplate string
    user define alarm notice.
    MultiConditions List<ClsAlarmMultiCondition>
    Multiple triggering conditions.
    Name string
    log alarm name.
    Status bool
    whether to enable the alarm policy.
    Tags Dictionary<string, string>
    Tag description list.
    AlarmNoticeIds []string
    list of alarm notice id.
    AlarmPeriod float64
    alarm repeat cycle.
    AlarmTargets []ClsAlarmAlarmTargetArgs
    list of alarm target.
    MonitorTime ClsAlarmMonitorTimeArgs
    monitor task execution time.
    TriggerCount float64
    continuous cycle.
    AlarmLevel float64
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    Analyses []ClsAlarmAnalysisArgs
    multidimensional analysis.
    CallBack ClsAlarmCallBackArgs
    user define callback.
    ClsAlarmId string
    ID of the resource.
    Condition string
    Trigger condition.
    MessageTemplate string
    user define alarm notice.
    MultiConditions []ClsAlarmMultiConditionArgs
    Multiple triggering conditions.
    Name string
    log alarm name.
    Status bool
    whether to enable the alarm policy.
    Tags map[string]string
    Tag description list.
    alarmNoticeIds List<String>
    list of alarm notice id.
    alarmPeriod Double
    alarm repeat cycle.
    alarmTargets List<ClsAlarmAlarmTarget>
    list of alarm target.
    monitorTime ClsAlarmMonitorTime
    monitor task execution time.
    triggerCount Double
    continuous cycle.
    alarmLevel Double
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    analyses List<ClsAlarmAnalysis>
    multidimensional analysis.
    callBack ClsAlarmCallBack
    user define callback.
    clsAlarmId String
    ID of the resource.
    condition String
    Trigger condition.
    messageTemplate String
    user define alarm notice.
    multiConditions List<ClsAlarmMultiCondition>
    Multiple triggering conditions.
    name String
    log alarm name.
    status Boolean
    whether to enable the alarm policy.
    tags Map<String,String>
    Tag description list.
    alarmNoticeIds string[]
    list of alarm notice id.
    alarmPeriod number
    alarm repeat cycle.
    alarmTargets ClsAlarmAlarmTarget[]
    list of alarm target.
    monitorTime ClsAlarmMonitorTime
    monitor task execution time.
    triggerCount number
    continuous cycle.
    alarmLevel number
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    analyses ClsAlarmAnalysis[]
    multidimensional analysis.
    callBack ClsAlarmCallBack
    user define callback.
    clsAlarmId string
    ID of the resource.
    condition string
    Trigger condition.
    messageTemplate string
    user define alarm notice.
    multiConditions ClsAlarmMultiCondition[]
    Multiple triggering conditions.
    name string
    log alarm name.
    status boolean
    whether to enable the alarm policy.
    tags {[key: string]: string}
    Tag description list.
    alarm_notice_ids Sequence[str]
    list of alarm notice id.
    alarm_period float
    alarm repeat cycle.
    alarm_targets Sequence[ClsAlarmAlarmTargetArgs]
    list of alarm target.
    monitor_time ClsAlarmMonitorTimeArgs
    monitor task execution time.
    trigger_count float
    continuous cycle.
    alarm_level float
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    analyses Sequence[ClsAlarmAnalysisArgs]
    multidimensional analysis.
    call_back ClsAlarmCallBackArgs
    user define callback.
    cls_alarm_id str
    ID of the resource.
    condition str
    Trigger condition.
    message_template str
    user define alarm notice.
    multi_conditions Sequence[ClsAlarmMultiConditionArgs]
    Multiple triggering conditions.
    name str
    log alarm name.
    status bool
    whether to enable the alarm policy.
    tags Mapping[str, str]
    Tag description list.
    alarmNoticeIds List<String>
    list of alarm notice id.
    alarmPeriod Number
    alarm repeat cycle.
    alarmTargets List<Property Map>
    list of alarm target.
    monitorTime Property Map
    monitor task execution time.
    triggerCount Number
    continuous cycle.
    alarmLevel Number
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    analyses List<Property Map>
    multidimensional analysis.
    callBack Property Map
    user define callback.
    clsAlarmId String
    ID of the resource.
    condition String
    Trigger condition.
    messageTemplate String
    user define alarm notice.
    multiConditions List<Property Map>
    Multiple triggering conditions.
    name String
    log alarm name.
    status Boolean
    whether to enable the alarm policy.
    tags Map<String>
    Tag description list.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClsAlarm resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ClsAlarm Resource

    Get an existing ClsAlarm resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClsAlarmState, opts?: CustomResourceOptions): ClsAlarm
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alarm_level: Optional[float] = None,
        alarm_notice_ids: Optional[Sequence[str]] = None,
        alarm_period: Optional[float] = None,
        alarm_targets: Optional[Sequence[ClsAlarmAlarmTargetArgs]] = None,
        analyses: Optional[Sequence[ClsAlarmAnalysisArgs]] = None,
        call_back: Optional[ClsAlarmCallBackArgs] = None,
        cls_alarm_id: Optional[str] = None,
        condition: Optional[str] = None,
        message_template: Optional[str] = None,
        monitor_time: Optional[ClsAlarmMonitorTimeArgs] = None,
        multi_conditions: Optional[Sequence[ClsAlarmMultiConditionArgs]] = None,
        name: Optional[str] = None,
        status: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        trigger_count: Optional[float] = None) -> ClsAlarm
    func GetClsAlarm(ctx *Context, name string, id IDInput, state *ClsAlarmState, opts ...ResourceOption) (*ClsAlarm, error)
    public static ClsAlarm Get(string name, Input<string> id, ClsAlarmState? state, CustomResourceOptions? opts = null)
    public static ClsAlarm get(String name, Output<String> id, ClsAlarmState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:ClsAlarm    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AlarmLevel double
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    AlarmNoticeIds List<string>
    list of alarm notice id.
    AlarmPeriod double
    alarm repeat cycle.
    AlarmTargets List<ClsAlarmAlarmTarget>
    list of alarm target.
    Analyses List<ClsAlarmAnalysis>
    multidimensional analysis.
    CallBack ClsAlarmCallBack
    user define callback.
    ClsAlarmId string
    ID of the resource.
    Condition string
    Trigger condition.
    MessageTemplate string
    user define alarm notice.
    MonitorTime ClsAlarmMonitorTime
    monitor task execution time.
    MultiConditions List<ClsAlarmMultiCondition>
    Multiple triggering conditions.
    Name string
    log alarm name.
    Status bool
    whether to enable the alarm policy.
    Tags Dictionary<string, string>
    Tag description list.
    TriggerCount double
    continuous cycle.
    AlarmLevel float64
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    AlarmNoticeIds []string
    list of alarm notice id.
    AlarmPeriod float64
    alarm repeat cycle.
    AlarmTargets []ClsAlarmAlarmTargetArgs
    list of alarm target.
    Analyses []ClsAlarmAnalysisArgs
    multidimensional analysis.
    CallBack ClsAlarmCallBackArgs
    user define callback.
    ClsAlarmId string
    ID of the resource.
    Condition string
    Trigger condition.
    MessageTemplate string
    user define alarm notice.
    MonitorTime ClsAlarmMonitorTimeArgs
    monitor task execution time.
    MultiConditions []ClsAlarmMultiConditionArgs
    Multiple triggering conditions.
    Name string
    log alarm name.
    Status bool
    whether to enable the alarm policy.
    Tags map[string]string
    Tag description list.
    TriggerCount float64
    continuous cycle.
    alarmLevel Double
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    alarmNoticeIds List<String>
    list of alarm notice id.
    alarmPeriod Double
    alarm repeat cycle.
    alarmTargets List<ClsAlarmAlarmTarget>
    list of alarm target.
    analyses List<ClsAlarmAnalysis>
    multidimensional analysis.
    callBack ClsAlarmCallBack
    user define callback.
    clsAlarmId String
    ID of the resource.
    condition String
    Trigger condition.
    messageTemplate String
    user define alarm notice.
    monitorTime ClsAlarmMonitorTime
    monitor task execution time.
    multiConditions List<ClsAlarmMultiCondition>
    Multiple triggering conditions.
    name String
    log alarm name.
    status Boolean
    whether to enable the alarm policy.
    tags Map<String,String>
    Tag description list.
    triggerCount Double
    continuous cycle.
    alarmLevel number
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    alarmNoticeIds string[]
    list of alarm notice id.
    alarmPeriod number
    alarm repeat cycle.
    alarmTargets ClsAlarmAlarmTarget[]
    list of alarm target.
    analyses ClsAlarmAnalysis[]
    multidimensional analysis.
    callBack ClsAlarmCallBack
    user define callback.
    clsAlarmId string
    ID of the resource.
    condition string
    Trigger condition.
    messageTemplate string
    user define alarm notice.
    monitorTime ClsAlarmMonitorTime
    monitor task execution time.
    multiConditions ClsAlarmMultiCondition[]
    Multiple triggering conditions.
    name string
    log alarm name.
    status boolean
    whether to enable the alarm policy.
    tags {[key: string]: string}
    Tag description list.
    triggerCount number
    continuous cycle.
    alarm_level float
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    alarm_notice_ids Sequence[str]
    list of alarm notice id.
    alarm_period float
    alarm repeat cycle.
    alarm_targets Sequence[ClsAlarmAlarmTargetArgs]
    list of alarm target.
    analyses Sequence[ClsAlarmAnalysisArgs]
    multidimensional analysis.
    call_back ClsAlarmCallBackArgs
    user define callback.
    cls_alarm_id str
    ID of the resource.
    condition str
    Trigger condition.
    message_template str
    user define alarm notice.
    monitor_time ClsAlarmMonitorTimeArgs
    monitor task execution time.
    multi_conditions Sequence[ClsAlarmMultiConditionArgs]
    Multiple triggering conditions.
    name str
    log alarm name.
    status bool
    whether to enable the alarm policy.
    tags Mapping[str, str]
    Tag description list.
    trigger_count float
    continuous cycle.
    alarmLevel Number
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    alarmNoticeIds List<String>
    list of alarm notice id.
    alarmPeriod Number
    alarm repeat cycle.
    alarmTargets List<Property Map>
    list of alarm target.
    analyses List<Property Map>
    multidimensional analysis.
    callBack Property Map
    user define callback.
    clsAlarmId String
    ID of the resource.
    condition String
    Trigger condition.
    messageTemplate String
    user define alarm notice.
    monitorTime Property Map
    monitor task execution time.
    multiConditions List<Property Map>
    Multiple triggering conditions.
    name String
    log alarm name.
    status Boolean
    whether to enable the alarm policy.
    tags Map<String>
    Tag description list.
    triggerCount Number
    continuous cycle.

    Supporting Types

    ClsAlarmAlarmTarget, ClsAlarmAlarmTargetArgs

    EndTimeOffset double
    search end time of offset.
    LogsetId string
    logset id.
    Number double
    the number of alarm object.
    Query string
    query rules.
    StartTimeOffset double
    search start time of offset.
    TopicId string
    topic id.
    SyntaxRule double
    Retrieve grammar rules, 0: Lucene syntax, 1: CQL syntax, Default value is 0.
    EndTimeOffset float64
    search end time of offset.
    LogsetId string
    logset id.
    Number float64
    the number of alarm object.
    Query string
    query rules.
    StartTimeOffset float64
    search start time of offset.
    TopicId string
    topic id.
    SyntaxRule float64
    Retrieve grammar rules, 0: Lucene syntax, 1: CQL syntax, Default value is 0.
    endTimeOffset Double
    search end time of offset.
    logsetId String
    logset id.
    number Double
    the number of alarm object.
    query String
    query rules.
    startTimeOffset Double
    search start time of offset.
    topicId String
    topic id.
    syntaxRule Double
    Retrieve grammar rules, 0: Lucene syntax, 1: CQL syntax, Default value is 0.
    endTimeOffset number
    search end time of offset.
    logsetId string
    logset id.
    number number
    the number of alarm object.
    query string
    query rules.
    startTimeOffset number
    search start time of offset.
    topicId string
    topic id.
    syntaxRule number
    Retrieve grammar rules, 0: Lucene syntax, 1: CQL syntax, Default value is 0.
    end_time_offset float
    search end time of offset.
    logset_id str
    logset id.
    number float
    the number of alarm object.
    query str
    query rules.
    start_time_offset float
    search start time of offset.
    topic_id str
    topic id.
    syntax_rule float
    Retrieve grammar rules, 0: Lucene syntax, 1: CQL syntax, Default value is 0.
    endTimeOffset Number
    search end time of offset.
    logsetId String
    logset id.
    number Number
    the number of alarm object.
    query String
    query rules.
    startTimeOffset Number
    search start time of offset.
    topicId String
    topic id.
    syntaxRule Number
    Retrieve grammar rules, 0: Lucene syntax, 1: CQL syntax, Default value is 0.

    ClsAlarmAnalysis, ClsAlarmAnalysisArgs

    Content string
    analysis content.
    Name string
    analysis name.
    Type string
    analysis type.
    ConfigInfos List<ClsAlarmAnalysisConfigInfo>
    configuration.
    Content string
    analysis content.
    Name string
    analysis name.
    Type string
    analysis type.
    ConfigInfos []ClsAlarmAnalysisConfigInfo
    configuration.
    content String
    analysis content.
    name String
    analysis name.
    type String
    analysis type.
    configInfos List<ClsAlarmAnalysisConfigInfo>
    configuration.
    content string
    analysis content.
    name string
    analysis name.
    type string
    analysis type.
    configInfos ClsAlarmAnalysisConfigInfo[]
    configuration.
    content str
    analysis content.
    name str
    analysis name.
    type str
    analysis type.
    config_infos Sequence[ClsAlarmAnalysisConfigInfo]
    configuration.
    content String
    analysis content.
    name String
    analysis name.
    type String
    analysis type.
    configInfos List<Property Map>
    configuration.

    ClsAlarmAnalysisConfigInfo, ClsAlarmAnalysisConfigInfoArgs

    Key string
    key.
    Value string
    value.
    Key string
    key.
    Value string
    value.
    key String
    key.
    value String
    value.
    key string
    key.
    value string
    value.
    key str
    key.
    value str
    value.
    key String
    key.
    value String
    value.

    ClsAlarmCallBack, ClsAlarmCallBackArgs

    Body string
    callback body.
    Headers List<string>
    callback headers.
    Body string
    callback body.
    Headers []string
    callback headers.
    body String
    callback body.
    headers List<String>
    callback headers.
    body string
    callback body.
    headers string[]
    callback headers.
    body str
    callback body.
    headers Sequence[str]
    callback headers.
    body String
    callback body.
    headers List<String>
    callback headers.

    ClsAlarmMonitorTime, ClsAlarmMonitorTimeArgs

    Time double
    time period or point in time.
    Type string
    Period for periodic execution, Fixed for regular execution.
    Time float64
    time period or point in time.
    Type string
    Period for periodic execution, Fixed for regular execution.
    time Double
    time period or point in time.
    type String
    Period for periodic execution, Fixed for regular execution.
    time number
    time period or point in time.
    type string
    Period for periodic execution, Fixed for regular execution.
    time float
    time period or point in time.
    type str
    Period for periodic execution, Fixed for regular execution.
    time Number
    time period or point in time.
    type String
    Period for periodic execution, Fixed for regular execution.

    ClsAlarmMultiCondition, ClsAlarmMultiConditionArgs

    AlarmLevel double
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    Condition string
    Trigger condition.
    AlarmLevel float64
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    Condition string
    Trigger condition.
    alarmLevel Double
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    condition String
    Trigger condition.
    alarmLevel number
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    condition string
    Trigger condition.
    alarm_level float
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    condition str
    Trigger condition.
    alarmLevel Number
    Alarm level. 0: Warning; 1: Info; 2: Critical. Default is 0.
    condition String
    Trigger condition.

    Import

    cls alarm can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/clsAlarm:ClsAlarm example alarm-d8529662-e10f-440c-ba80-50f3dcf215a3

    To learn more about importing existing cloud resources, see Importing resources.

    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