Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine.tls.Alarms
Explore with Pulumi AI
Use this data source to query detailed information of tls alarms
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
const default = volcengine.tls.Alarms({
    projectId: "cc44f8b6-0328-4622-b043-023fca735cd4",
});
import pulumi
import pulumi_volcengine as volcengine
default = volcengine.tls.alarms(project_id="cc44f8b6-0328-4622-b043-023fca735cd4")
package main
import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tls"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tls.Alarms(ctx, &tls.AlarmsArgs{
			ProjectId: "cc44f8b6-0328-4622-b043-023fca735cd4",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Tls.Alarms.Invoke(new()
    {
        ProjectId = "cc44f8b6-0328-4622-b043-023fca735cd4",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.TlsFunctions;
import com.pulumi.volcengine.tls.inputs.AlarmsArgs;
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 default = TlsFunctions.Alarms(AlarmsArgs.builder()
            .projectId("cc44f8b6-0328-4622-b043-023fca735cd4")
            .build());
    }
}
variables:
  default:
    fn::invoke:
      Function: volcengine:tls:Alarms
      Arguments:
        projectId: cc44f8b6-0328-4622-b043-023fca735cd4
Using Alarms
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 alarms(args: AlarmsArgs, opts?: InvokeOptions): Promise<AlarmsResult>
function alarmsOutput(args: AlarmsOutputArgs, opts?: InvokeOptions): Output<AlarmsResult>def alarms(alarm_id: Optional[str] = None,
           alarm_name: Optional[str] = None,
           output_file: Optional[str] = None,
           project_id: Optional[str] = None,
           status: Optional[bool] = None,
           topic_id: Optional[str] = None,
           topic_name: Optional[str] = None,
           opts: Optional[InvokeOptions] = None) -> AlarmsResult
def alarms_output(alarm_id: Optional[pulumi.Input[str]] = None,
           alarm_name: Optional[pulumi.Input[str]] = None,
           output_file: Optional[pulumi.Input[str]] = None,
           project_id: Optional[pulumi.Input[str]] = None,
           status: Optional[pulumi.Input[bool]] = None,
           topic_id: Optional[pulumi.Input[str]] = None,
           topic_name: Optional[pulumi.Input[str]] = None,
           opts: Optional[InvokeOptions] = None) -> Output[AlarmsResult]func Alarms(ctx *Context, args *AlarmsArgs, opts ...InvokeOption) (*AlarmsResult, error)
func AlarmsOutput(ctx *Context, args *AlarmsOutputArgs, opts ...InvokeOption) AlarmsResultOutputpublic static class Alarms 
{
    public static Task<AlarmsResult> InvokeAsync(AlarmsArgs args, InvokeOptions? opts = null)
    public static Output<AlarmsResult> Invoke(AlarmsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<AlarmsResult> alarms(AlarmsArgs args, InvokeOptions options)
public static Output<AlarmsResult> alarms(AlarmsArgs args, InvokeOptions options)
fn::invoke:
  function: volcengine:tls:Alarms
  arguments:
    # arguments dictionaryThe following arguments are supported:
- project_id str
- The project id.
- alarm_id str
- The alarm id.
- alarm_name str
- The alarm name.
- output_file str
- File name where to save data source results.
- status bool
- The status.
- topic_id str
- The topic id.
- topic_name str
- The topic name.
Alarms Result
The following output properties are available:
- Alarms
List<AlarmsAlarm> 
- The list of alarms.
- Id string
- The provider-assigned unique ID for this managed resource.
- ProjectId string
- The project id.
- TotalCount int
- The total count of query.
- AlarmId string
- The alarm id.
- AlarmName string
- The name of the alarm.
- OutputFile string
- Status bool
- Whether to enable the alert policy. The default value is true, that is, on.
- TopicId string
- The id of the topic.
- TopicName string
- The name of the topic.
- Alarms
[]AlarmsAlarm 
- The list of alarms.
- Id string
- The provider-assigned unique ID for this managed resource.
- ProjectId string
- The project id.
- TotalCount int
- The total count of query.
- AlarmId string
- The alarm id.
- AlarmName string
- The name of the alarm.
- OutputFile string
- Status bool
- Whether to enable the alert policy. The default value is true, that is, on.
- TopicId string
- The id of the topic.
- TopicName string
- The name of the topic.
- alarms
List<AlarmsAlarm> 
- The list of alarms.
- id String
- The provider-assigned unique ID for this managed resource.
- projectId String
- The project id.
- totalCount Integer
- The total count of query.
- alarmId String
- The alarm id.
- alarmName String
- The name of the alarm.
- outputFile String
- status Boolean
- Whether to enable the alert policy. The default value is true, that is, on.
- topicId String
- The id of the topic.
- topicName String
- The name of the topic.
- alarms
AlarmsAlarm[] 
- The list of alarms.
- id string
- The provider-assigned unique ID for this managed resource.
- projectId string
- The project id.
- totalCount number
- The total count of query.
- alarmId string
- The alarm id.
- alarmName string
- The name of the alarm.
- outputFile string
- status boolean
- Whether to enable the alert policy. The default value is true, that is, on.
- topicId string
- The id of the topic.
- topicName string
- The name of the topic.
- alarms
Sequence[AlarmsAlarm] 
- The list of alarms.
- id str
- The provider-assigned unique ID for this managed resource.
- project_id str
- The project id.
- total_count int
- The total count of query.
- alarm_id str
- The alarm id.
- alarm_name str
- The name of the alarm.
- output_file str
- status bool
- Whether to enable the alert policy. The default value is true, that is, on.
- topic_id str
- The id of the topic.
- topic_name str
- The name of the topic.
- alarms List<Property Map>
- The list of alarms.
- id String
- The provider-assigned unique ID for this managed resource.
- projectId String
- The project id.
- totalCount Number
- The total count of query.
- alarmId String
- The alarm id.
- alarmName String
- The name of the alarm.
- outputFile String
- status Boolean
- Whether to enable the alert policy. The default value is true, that is, on.
- topicId String
- The id of the topic.
- topicName String
- The name of the topic.
Supporting Types
AlarmsAlarm 
- AlarmId string
- The alarm id.
- AlarmName string
- The alarm name.
- AlarmNotify List<AlarmsGroups Alarm Alarm Notify Group> 
- List of notification groups corresponding to the alarm.
- AlarmPeriod int
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- AlarmPeriod List<AlarmsDetails Alarm Alarm Period Detail> 
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- Condition string
- Alarm trigger condition.
- CreateTime string
- The create time.
- ModifyTime string
- The modify time.
- ProjectId string
- The project id.
- QueryRequests List<AlarmsAlarm Query Request> 
- Search and analyze sentences, 1~3 can be configured.
- RequestCycles List<AlarmsAlarm Request Cycle> 
- The execution period of the alarm task.
- Status bool
- The status.
- TriggerPeriod int
- Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- UserDefine stringMsg 
- Customize the alarm notification content.
- AlarmId string
- The alarm id.
- AlarmName string
- The alarm name.
- AlarmNotify []AlarmsGroups Alarm Alarm Notify Group 
- List of notification groups corresponding to the alarm.
- AlarmPeriod int
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- AlarmPeriod []AlarmsDetails Alarm Alarm Period Detail 
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- Condition string
- Alarm trigger condition.
- CreateTime string
- The create time.
- ModifyTime string
- The modify time.
- ProjectId string
- The project id.
- QueryRequests []AlarmsAlarm Query Request 
- Search and analyze sentences, 1~3 can be configured.
- RequestCycles []AlarmsAlarm Request Cycle 
- The execution period of the alarm task.
- Status bool
- The status.
- TriggerPeriod int
- Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- UserDefine stringMsg 
- Customize the alarm notification content.
- alarmId String
- The alarm id.
- alarmName String
- The alarm name.
- alarmNotify List<AlarmsGroups Alarm Alarm Notify Group> 
- List of notification groups corresponding to the alarm.
- alarmPeriod Integer
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- alarmPeriod List<AlarmsDetails Alarm Alarm Period Detail> 
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- condition String
- Alarm trigger condition.
- createTime String
- The create time.
- modifyTime String
- The modify time.
- projectId String
- The project id.
- queryRequests List<AlarmsAlarm Query Request> 
- Search and analyze sentences, 1~3 can be configured.
- requestCycles List<AlarmsAlarm Request Cycle> 
- The execution period of the alarm task.
- status Boolean
- The status.
- triggerPeriod Integer
- Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- userDefine StringMsg 
- Customize the alarm notification content.
- alarmId string
- The alarm id.
- alarmName string
- The alarm name.
- alarmNotify AlarmsGroups Alarm Alarm Notify Group[] 
- List of notification groups corresponding to the alarm.
- alarmPeriod number
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- alarmPeriod AlarmsDetails Alarm Alarm Period Detail[] 
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- condition string
- Alarm trigger condition.
- createTime string
- The create time.
- modifyTime string
- The modify time.
- projectId string
- The project id.
- queryRequests AlarmsAlarm Query Request[] 
- Search and analyze sentences, 1~3 can be configured.
- requestCycles AlarmsAlarm Request Cycle[] 
- The execution period of the alarm task.
- status boolean
- The status.
- triggerPeriod number
- Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- userDefine stringMsg 
- Customize the alarm notification content.
- alarm_id str
- The alarm id.
- alarm_name str
- The alarm name.
- alarm_notify_ Sequence[Alarmsgroups Alarm Alarm Notify Group] 
- List of notification groups corresponding to the alarm.
- alarm_period int
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- alarm_period_ Sequence[Alarmsdetails Alarm Alarm Period Detail] 
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- condition str
- Alarm trigger condition.
- create_time str
- The create time.
- modify_time str
- The modify time.
- project_id str
- The project id.
- query_requests Sequence[AlarmsAlarm Query Request] 
- Search and analyze sentences, 1~3 can be configured.
- request_cycles Sequence[AlarmsAlarm Request Cycle] 
- The execution period of the alarm task.
- status bool
- The status.
- trigger_period int
- Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- user_define_ strmsg 
- Customize the alarm notification content.
- alarmId String
- The alarm id.
- alarmName String
- The alarm name.
- alarmNotify List<Property Map>Groups 
- List of notification groups corresponding to the alarm.
- alarmPeriod Number
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- alarmPeriod List<Property Map>Details 
- Period for sending alarm notifications. When the number of continuous alarm triggers reaches the specified limit (TriggerPeriod), Log Service will send alarm notifications according to the specified period.
- condition String
- Alarm trigger condition.
- createTime String
- The create time.
- modifyTime String
- The modify time.
- projectId String
- The project id.
- queryRequests List<Property Map>
- Search and analyze sentences, 1~3 can be configured.
- requestCycles List<Property Map>
- The execution period of the alarm task.
- status Boolean
- The status.
- triggerPeriod Number
- Continuous cycle. The alarm will be issued after the trigger condition is continuously met for TriggerPeriod periods; the minimum value is 1, the maximum value is 10, and the default value is 1.
- userDefine StringMsg 
- Customize the alarm notification content.
AlarmsAlarmAlarmNotifyGroup    
- AlarmNotify stringGroup Id 
- The id of the notify group.
- AlarmNotify stringGroup Name 
- Name of the notification group.
- CreateTime string
- The create time.
- IamProject stringName 
- The iam project name.
- ModifyTime string
- The modify time.
- NotifyTypes List<string>
- The notify group type.
- Receivers
List<AlarmsAlarm Alarm Notify Group Receiver> 
- List of IAM users to receive alerts.
- AlarmNotify stringGroup Id 
- The id of the notify group.
- AlarmNotify stringGroup Name 
- Name of the notification group.
- CreateTime string
- The create time.
- IamProject stringName 
- The iam project name.
- ModifyTime string
- The modify time.
- NotifyTypes []string
- The notify group type.
- Receivers
[]AlarmsAlarm Alarm Notify Group Receiver 
- List of IAM users to receive alerts.
- alarmNotify StringGroup Id 
- The id of the notify group.
- alarmNotify StringGroup Name 
- Name of the notification group.
- createTime String
- The create time.
- iamProject StringName 
- The iam project name.
- modifyTime String
- The modify time.
- notifyTypes List<String>
- The notify group type.
- receivers
List<AlarmsAlarm Alarm Notify Group Receiver> 
- List of IAM users to receive alerts.
- alarmNotify stringGroup Id 
- The id of the notify group.
- alarmNotify stringGroup Name 
- Name of the notification group.
- createTime string
- The create time.
- iamProject stringName 
- The iam project name.
- modifyTime string
- The modify time.
- notifyTypes string[]
- The notify group type.
- receivers
AlarmsAlarm Alarm Notify Group Receiver[] 
- List of IAM users to receive alerts.
- alarm_notify_ strgroup_ id 
- The id of the notify group.
- alarm_notify_ strgroup_ name 
- Name of the notification group.
- create_time str
- The create time.
- iam_project_ strname 
- The iam project name.
- modify_time str
- The modify time.
- notify_types Sequence[str]
- The notify group type.
- receivers
Sequence[AlarmsAlarm Alarm Notify Group Receiver] 
- List of IAM users to receive alerts.
- alarmNotify StringGroup Id 
- The id of the notify group.
- alarmNotify StringGroup Name 
- Name of the notification group.
- createTime String
- The create time.
- iamProject StringName 
- The iam project name.
- modifyTime String
- The modify time.
- notifyTypes List<String>
- The notify group type.
- receivers List<Property Map>
- List of IAM users to receive alerts.
AlarmsAlarmAlarmNotifyGroupReceiver     
- EndTime string
- The end time.
- ReceiverChannels List<string>
- The list of the receiver channels.
- ReceiverNames List<string>
- List of the receiver names.
- ReceiverType string
- The receiver type.
- StartTime string
- The start time.
- EndTime string
- The end time.
- ReceiverChannels []string
- The list of the receiver channels.
- ReceiverNames []string
- List of the receiver names.
- ReceiverType string
- The receiver type.
- StartTime string
- The start time.
- endTime String
- The end time.
- receiverChannels List<String>
- The list of the receiver channels.
- receiverNames List<String>
- List of the receiver names.
- receiverType String
- The receiver type.
- startTime String
- The start time.
- endTime string
- The end time.
- receiverChannels string[]
- The list of the receiver channels.
- receiverNames string[]
- List of the receiver names.
- receiverType string
- The receiver type.
- startTime string
- The start time.
- end_time str
- The end time.
- receiver_channels Sequence[str]
- The list of the receiver channels.
- receiver_names Sequence[str]
- List of the receiver names.
- receiver_type str
- The receiver type.
- start_time str
- The start time.
- endTime String
- The end time.
- receiverChannels List<String>
- The list of the receiver channels.
- receiverNames List<String>
- List of the receiver names.
- receiverType String
- The receiver type.
- startTime String
- The start time.
AlarmsAlarmAlarmPeriodDetail    
- Email int
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- GeneralWebhook int
- Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- Phone int
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- Sms int
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
- Email int
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- GeneralWebhook int
- Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- Phone int
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- Sms int
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
- email Integer
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- generalWebhook Integer
- Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- phone Integer
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- sms Integer
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
- email number
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- generalWebhook number
- Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- phone number
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- sms number
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
- email int
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- general_webhook int
- Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- phone int
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- sms int
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
- email Number
- Email alarm period, the unit is minutes, and the value range is 1~1440.
- generalWebhook Number
- Customize the webhook alarm period, the unit is minutes, and the value range is 1~1440.
- phone Number
- Telephone alarm cycle, the unit is minutes, and the value range is 10~1440.
- sms Number
- SMS alarm cycle, the unit is minutes, and the value range is 10~1440.
AlarmsAlarmQueryRequest   
- EndTime intOffset 
- The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- Number int
- Alarm object sequence number; increments from 1.
- Query string
- Query statement, the maximum supported length is 1024.
- StartTime intOffset 
- The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- TopicId string
- The topic id.
- TopicName string
- The topic name.
- EndTime intOffset 
- The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- Number int
- Alarm object sequence number; increments from 1.
- Query string
- Query statement, the maximum supported length is 1024.
- StartTime intOffset 
- The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- TopicId string
- The topic id.
- TopicName string
- The topic name.
- endTime IntegerOffset 
- The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- number Integer
- Alarm object sequence number; increments from 1.
- query String
- Query statement, the maximum supported length is 1024.
- startTime IntegerOffset 
- The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- topicId String
- The topic id.
- topicName String
- The topic name.
- endTime numberOffset 
- The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- number number
- Alarm object sequence number; increments from 1.
- query string
- Query statement, the maximum supported length is 1024.
- startTime numberOffset 
- The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- topicId string
- The topic id.
- topicName string
- The topic name.
- end_time_ intoffset 
- The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- number int
- Alarm object sequence number; increments from 1.
- query str
- Query statement, the maximum supported length is 1024.
- start_time_ intoffset 
- The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- topic_id str
- The topic id.
- topic_name str
- The topic name.
- endTime NumberOffset 
- The end time of the query range is relative to the current historical time. The unit is minutes. The value is not positive and must be greater than StartTimeOffset. The maximum value is 0 and the minimum value is -1440.
- number Number
- Alarm object sequence number; increments from 1.
- query String
- Query statement, the maximum supported length is 1024.
- startTime NumberOffset 
- The start time of the query range is relative to the current historical time, in minutes. The value is non-positive, the maximum value is 0, and the minimum value is -1440.
- topicId String
- The topic id.
- topicName String
- The topic name.
AlarmsAlarmRequestCycle   
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the volcengineTerraform Provider.