Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. cloud_monitor
  5. getRules
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.cloud_monitor.getRules

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

    Use this data source to query detailed information of cloud monitor rules

    Example Usage

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

const foo = volcengine.cloud_monitor.getRules({
    ids: ["174402785374661****"],
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.cloud_monitor.get_rules(ids=["174402785374661****"])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/cloud_monitor"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloud_monitor.GetRules(ctx, &cloud_monitor.GetRulesArgs{
			Ids: []string{
				"174402785374661****",
			},
		}, 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 foo = Volcengine.Cloud_monitor.GetRules.Invoke(new()
    {
        Ids = new[]
        {
            "174402785374661****",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.cloud_monitor.Cloud_monitorFunctions;
import com.pulumi.volcengine.cloud_monitor.inputs.GetRulesArgs;
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 foo = Cloud_monitorFunctions.getRules(GetRulesArgs.builder()
            .ids("174402785374661****")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:cloud_monitor:getRules
      Arguments:
        ids:
          - 174402785374661****

    Using getRules

    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 getRules(args: GetRulesArgs, opts?: InvokeOptions): Promise<GetRulesResult>
function getRulesOutput(args: GetRulesOutputArgs, opts?: InvokeOptions): Output<GetRulesResult>
    def get_rules(alert_states: Optional[Sequence[str]] = None,
              enable_states: Optional[Sequence[str]] = None,
              ids: Optional[Sequence[str]] = None,
              levels: Optional[Sequence[str]] = None,
              name_regex: Optional[str] = None,
              namespaces: Optional[Sequence[str]] = None,
              output_file: Optional[str] = None,
              rule_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetRulesResult
def get_rules_output(alert_states: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              enable_states: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              levels: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              name_regex: Optional[pulumi.Input[str]] = None,
              namespaces: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              rule_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRulesResult]
    func GetRules(ctx *Context, args *GetRulesArgs, opts ...InvokeOption) (*GetRulesResult, error)
func GetRulesOutput(ctx *Context, args *GetRulesOutputArgs, opts ...InvokeOption) GetRulesResultOutput

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

    public static class GetRules 
{
    public static Task<GetRulesResult> InvokeAsync(GetRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetRulesResult> Invoke(GetRulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRulesResult> getRules(GetRulesArgs args, InvokeOptions options)
public static Output<GetRulesResult> getRules(GetRulesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:cloud_monitor/getRules:getRules
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AlertStates List<string>
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    EnableStates List<string>
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    Ids List<string>
    A list of cloud monitor ids.
    Levels List<string>
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    NameRegex string
    A Name Regex of Resource.
    Namespaces List<string>
    The namespace of the cloud monitor rule.
    OutputFile string
    File name where to save data source results.
    RuleName string
    The name of the cloud monitor rule. This field support fuzzy query.
    AlertStates []string
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    EnableStates []string
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    Ids []string
    A list of cloud monitor ids.
    Levels []string
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    NameRegex string
    A Name Regex of Resource.
    Namespaces []string
    The namespace of the cloud monitor rule.
    OutputFile string
    File name where to save data source results.
    RuleName string
    The name of the cloud monitor rule. This field support fuzzy query.
    alertStates List<String>
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    enableStates List<String>
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    ids List<String>
    A list of cloud monitor ids.
    levels List<String>
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    nameRegex String
    A Name Regex of Resource.
    namespaces List<String>
    The namespace of the cloud monitor rule.
    outputFile String
    File name where to save data source results.
    ruleName String
    The name of the cloud monitor rule. This field support fuzzy query.
    alertStates string[]
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    enableStates string[]
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    ids string[]
    A list of cloud monitor ids.
    levels string[]
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    nameRegex string
    A Name Regex of Resource.
    namespaces string[]
    The namespace of the cloud monitor rule.
    outputFile string
    File name where to save data source results.
    ruleName string
    The name of the cloud monitor rule. This field support fuzzy query.
    alert_states Sequence[str]
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    enable_states Sequence[str]
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    ids Sequence[str]
    A list of cloud monitor ids.
    levels Sequence[str]
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    name_regex str
    A Name Regex of Resource.
    namespaces Sequence[str]
    The namespace of the cloud monitor rule.
    output_file str
    File name where to save data source results.
    rule_name str
    The name of the cloud monitor rule. This field support fuzzy query.
    alertStates List<String>
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    enableStates List<String>
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    ids List<String>
    A list of cloud monitor ids.
    levels List<String>
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    nameRegex String
    A Name Regex of Resource.
    namespaces List<String>
    The namespace of the cloud monitor rule.
    outputFile String
    File name where to save data source results.
    ruleName String
    The name of the cloud monitor rule. This field support fuzzy query.

    getRules Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Rules List<GetRulesRule>
    The collection of query.
    TotalCount int
    The total count of query.
    AlertStates List<string>
    The alert state of the cloud monitor rule.
    EnableStates List<string>
    The enable state of the cloud monitor rule.
    Ids List<string>
    Levels List<string>
    The level of the cloud monitor rule.
    NameRegex string
    Namespaces List<string>
    The namespace of the cloud monitor rule.
    OutputFile string
    RuleName string
    The name of the cloud monitor rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Rules []GetRulesRule
    The collection of query.
    TotalCount int
    The total count of query.
    AlertStates []string
    The alert state of the cloud monitor rule.
    EnableStates []string
    The enable state of the cloud monitor rule.
    Ids []string
    Levels []string
    The level of the cloud monitor rule.
    NameRegex string
    Namespaces []string
    The namespace of the cloud monitor rule.
    OutputFile string
    RuleName string
    The name of the cloud monitor rule.
    id String
    The provider-assigned unique ID for this managed resource.
    rules List<GetRulesRule>
    The collection of query.
    totalCount Integer
    The total count of query.
    alertStates List<String>
    The alert state of the cloud monitor rule.
    enableStates List<String>
    The enable state of the cloud monitor rule.
    ids List<String>
    levels List<String>
    The level of the cloud monitor rule.
    nameRegex String
    namespaces List<String>
    The namespace of the cloud monitor rule.
    outputFile String
    ruleName String
    The name of the cloud monitor rule.
    id string
    The provider-assigned unique ID for this managed resource.
    rules GetRulesRule[]
    The collection of query.
    totalCount number
    The total count of query.
    alertStates string[]
    The alert state of the cloud monitor rule.
    enableStates string[]
    The enable state of the cloud monitor rule.
    ids string[]
    levels string[]
    The level of the cloud monitor rule.
    nameRegex string
    namespaces string[]
    The namespace of the cloud monitor rule.
    outputFile string
    ruleName string
    The name of the cloud monitor rule.
    id str
    The provider-assigned unique ID for this managed resource.
    rules Sequence[GetRulesRule]
    The collection of query.
    total_count int
    The total count of query.
    alert_states Sequence[str]
    The alert state of the cloud monitor rule.
    enable_states Sequence[str]
    The enable state of the cloud monitor rule.
    ids Sequence[str]
    levels Sequence[str]
    The level of the cloud monitor rule.
    name_regex str
    namespaces Sequence[str]
    The namespace of the cloud monitor rule.
    output_file str
    rule_name str
    The name of the cloud monitor rule.
    id String
    The provider-assigned unique ID for this managed resource.
    rules List<Property Map>
    The collection of query.
    totalCount Number
    The total count of query.
    alertStates List<String>
    The alert state of the cloud monitor rule.
    enableStates List<String>
    The enable state of the cloud monitor rule.
    ids List<String>
    levels List<String>
    The level of the cloud monitor rule.
    nameRegex String
    namespaces List<String>
    The namespace of the cloud monitor rule.
    outputFile String
    ruleName String
    The name of the cloud monitor rule.

    Supporting Types

    GetRulesRule

    AlertMethods List<string>
    The alert methods of the cloud monitor rule.
    AlertState string
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    ConditionOperator string
    The condition operator of the cloud monitor rule. Valid values: &&, ||.
    Conditions List<GetRulesRuleCondition>
    The conditions of the cloud monitor rule.
    ContactGroupIds List<string>
    The contact group ids of the cloud monitor rule.
    CreatedAt string
    The created time of the cloud monitor rule.
    Description string
    The description of the cloud monitor rule.
    EffectEndAt string
    The effect end time of the cloud monitor rule.
    EffectStartAt string
    The effect start time of the cloud monitor rule.
    EnableState string
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    EvaluationCount int
    The evaluation count of the cloud monitor rule.
    Id string
    The id of the cloud monitor rule.
    Level string
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    MultipleConditions bool
    Whether to enable the multiple conditions function of the cloud monitor rule.
    Namespace string
    The namespace of the cloud monitor rule.
    OriginalDimensions List<GetRulesRuleOriginalDimension>
    The original dimensions of the cloud monitor rule.
    Regions List<string>
    The region id of the cloud monitor rule.
    RuleName string
    The name of the cloud monitor rule. This field support fuzzy query.
    SilenceTime int
    The silence time of the cloud monitor rule. Unit in minutes.
    SubNamespace string
    The sub namespace of the cloud monitor rule.
    UpdatedAt string
    The updated time of the cloud monitor rule.
    WebHook string
    The web hook of the cloud monitor rule.
    WebhookIds List<string>
    The webhook id list of the cloud monitor rule.
    AlertMethods []string
    The alert methods of the cloud monitor rule.
    AlertState string
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    ConditionOperator string
    The condition operator of the cloud monitor rule. Valid values: &&, ||.
    Conditions []GetRulesRuleCondition
    The conditions of the cloud monitor rule.
    ContactGroupIds []string
    The contact group ids of the cloud monitor rule.
    CreatedAt string
    The created time of the cloud monitor rule.
    Description string
    The description of the cloud monitor rule.
    EffectEndAt string
    The effect end time of the cloud monitor rule.
    EffectStartAt string
    The effect start time of the cloud monitor rule.
    EnableState string
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    EvaluationCount int
    The evaluation count of the cloud monitor rule.
    Id string
    The id of the cloud monitor rule.
    Level string
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    MultipleConditions bool
    Whether to enable the multiple conditions function of the cloud monitor rule.
    Namespace string
    The namespace of the cloud monitor rule.
    OriginalDimensions []GetRulesRuleOriginalDimension
    The original dimensions of the cloud monitor rule.
    Regions []string
    The region id of the cloud monitor rule.
    RuleName string
    The name of the cloud monitor rule. This field support fuzzy query.
    SilenceTime int
    The silence time of the cloud monitor rule. Unit in minutes.
    SubNamespace string
    The sub namespace of the cloud monitor rule.
    UpdatedAt string
    The updated time of the cloud monitor rule.
    WebHook string
    The web hook of the cloud monitor rule.
    WebhookIds []string
    The webhook id list of the cloud monitor rule.
    alertMethods List<String>
    The alert methods of the cloud monitor rule.
    alertState String
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    conditionOperator String
    The condition operator of the cloud monitor rule. Valid values: &&, ||.
    conditions List<GetRulesRuleCondition>
    The conditions of the cloud monitor rule.
    contactGroupIds List<String>
    The contact group ids of the cloud monitor rule.
    createdAt String
    The created time of the cloud monitor rule.
    description String
    The description of the cloud monitor rule.
    effectEndAt String
    The effect end time of the cloud monitor rule.
    effectStartAt String
    The effect start time of the cloud monitor rule.
    enableState String
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    evaluationCount Integer
    The evaluation count of the cloud monitor rule.
    id String
    The id of the cloud monitor rule.
    level String
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    multipleConditions Boolean
    Whether to enable the multiple conditions function of the cloud monitor rule.
    namespace String
    The namespace of the cloud monitor rule.
    originalDimensions List<GetRulesRuleOriginalDimension>
    The original dimensions of the cloud monitor rule.
    regions List<String>
    The region id of the cloud monitor rule.
    ruleName String
    The name of the cloud monitor rule. This field support fuzzy query.
    silenceTime Integer
    The silence time of the cloud monitor rule. Unit in minutes.
    subNamespace String
    The sub namespace of the cloud monitor rule.
    updatedAt String
    The updated time of the cloud monitor rule.
    webHook String
    The web hook of the cloud monitor rule.
    webhookIds List<String>
    The webhook id list of the cloud monitor rule.
    alertMethods string[]
    The alert methods of the cloud monitor rule.
    alertState string
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    conditionOperator string
    The condition operator of the cloud monitor rule. Valid values: &&, ||.
    conditions GetRulesRuleCondition[]
    The conditions of the cloud monitor rule.
    contactGroupIds string[]
    The contact group ids of the cloud monitor rule.
    createdAt string
    The created time of the cloud monitor rule.
    description string
    The description of the cloud monitor rule.
    effectEndAt string
    The effect end time of the cloud monitor rule.
    effectStartAt string
    The effect start time of the cloud monitor rule.
    enableState string
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    evaluationCount number
    The evaluation count of the cloud monitor rule.
    id string
    The id of the cloud monitor rule.
    level string
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    multipleConditions boolean
    Whether to enable the multiple conditions function of the cloud monitor rule.
    namespace string
    The namespace of the cloud monitor rule.
    originalDimensions GetRulesRuleOriginalDimension[]
    The original dimensions of the cloud monitor rule.
    regions string[]
    The region id of the cloud monitor rule.
    ruleName string
    The name of the cloud monitor rule. This field support fuzzy query.
    silenceTime number
    The silence time of the cloud monitor rule. Unit in minutes.
    subNamespace string
    The sub namespace of the cloud monitor rule.
    updatedAt string
    The updated time of the cloud monitor rule.
    webHook string
    The web hook of the cloud monitor rule.
    webhookIds string[]
    The webhook id list of the cloud monitor rule.
    alert_methods Sequence[str]
    The alert methods of the cloud monitor rule.
    alert_state str
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    condition_operator str
    The condition operator of the cloud monitor rule. Valid values: &&, ||.
    conditions Sequence[GetRulesRuleCondition]
    The conditions of the cloud monitor rule.
    contact_group_ids Sequence[str]
    The contact group ids of the cloud monitor rule.
    created_at str
    The created time of the cloud monitor rule.
    description str
    The description of the cloud monitor rule.
    effect_end_at str
    The effect end time of the cloud monitor rule.
    effect_start_at str
    The effect start time of the cloud monitor rule.
    enable_state str
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    evaluation_count int
    The evaluation count of the cloud monitor rule.
    id str
    The id of the cloud monitor rule.
    level str
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    multiple_conditions bool
    Whether to enable the multiple conditions function of the cloud monitor rule.
    namespace str
    The namespace of the cloud monitor rule.
    original_dimensions Sequence[GetRulesRuleOriginalDimension]
    The original dimensions of the cloud monitor rule.
    regions Sequence[str]
    The region id of the cloud monitor rule.
    rule_name str
    The name of the cloud monitor rule. This field support fuzzy query.
    silence_time int
    The silence time of the cloud monitor rule. Unit in minutes.
    sub_namespace str
    The sub namespace of the cloud monitor rule.
    updated_at str
    The updated time of the cloud monitor rule.
    web_hook str
    The web hook of the cloud monitor rule.
    webhook_ids Sequence[str]
    The webhook id list of the cloud monitor rule.
    alertMethods List<String>
    The alert methods of the cloud monitor rule.
    alertState String
    The alert state of the cloud monitor rule. Valid values: altering, normal.
    conditionOperator String
    The condition operator of the cloud monitor rule. Valid values: &&, ||.
    conditions List<Property Map>
    The conditions of the cloud monitor rule.
    contactGroupIds List<String>
    The contact group ids of the cloud monitor rule.
    createdAt String
    The created time of the cloud monitor rule.
    description String
    The description of the cloud monitor rule.
    effectEndAt String
    The effect end time of the cloud monitor rule.
    effectStartAt String
    The effect start time of the cloud monitor rule.
    enableState String
    The enable state of the cloud monitor rule. Valid values: enable, disable.
    evaluationCount Number
    The evaluation count of the cloud monitor rule.
    id String
    The id of the cloud monitor rule.
    level String
    The level of the cloud monitor rule. Valid values: critical, warning, notice.
    multipleConditions Boolean
    Whether to enable the multiple conditions function of the cloud monitor rule.
    namespace String
    The namespace of the cloud monitor rule.
    originalDimensions List<Property Map>
    The original dimensions of the cloud monitor rule.
    regions List<String>
    The region id of the cloud monitor rule.
    ruleName String
    The name of the cloud monitor rule. This field support fuzzy query.
    silenceTime Number
    The silence time of the cloud monitor rule. Unit in minutes.
    subNamespace String
    The sub namespace of the cloud monitor rule.
    updatedAt String
    The updated time of the cloud monitor rule.
    webHook String
    The web hook of the cloud monitor rule.
    webhookIds List<String>
    The webhook id list of the cloud monitor rule.

    GetRulesRuleCondition

    ComparisonOperator string
    The comparison operation of the cloud monitor rule.
    MetricName string
    The metric name of the cloud monitor rule.
    MetricUnit string
    The metric unit of the cloud monitor rule.
    Period string
    The period of the cloud monitor rule.
    Statistics string
    The statistics of the cloud monitor rule.
    Threshold string
    The threshold of the cloud monitor rule.
    ComparisonOperator string
    The comparison operation of the cloud monitor rule.
    MetricName string
    The metric name of the cloud monitor rule.
    MetricUnit string
    The metric unit of the cloud monitor rule.
    Period string
    The period of the cloud monitor rule.
    Statistics string
    The statistics of the cloud monitor rule.
    Threshold string
    The threshold of the cloud monitor rule.
    comparisonOperator String
    The comparison operation of the cloud monitor rule.
    metricName String
    The metric name of the cloud monitor rule.
    metricUnit String
    The metric unit of the cloud monitor rule.
    period String
    The period of the cloud monitor rule.
    statistics String
    The statistics of the cloud monitor rule.
    threshold String
    The threshold of the cloud monitor rule.
    comparisonOperator string
    The comparison operation of the cloud monitor rule.
    metricName string
    The metric name of the cloud monitor rule.
    metricUnit string
    The metric unit of the cloud monitor rule.
    period string
    The period of the cloud monitor rule.
    statistics string
    The statistics of the cloud monitor rule.
    threshold string
    The threshold of the cloud monitor rule.
    comparison_operator str
    The comparison operation of the cloud monitor rule.
    metric_name str
    The metric name of the cloud monitor rule.
    metric_unit str
    The metric unit of the cloud monitor rule.
    period str
    The period of the cloud monitor rule.
    statistics str
    The statistics of the cloud monitor rule.
    threshold str
    The threshold of the cloud monitor rule.
    comparisonOperator String
    The comparison operation of the cloud monitor rule.
    metricName String
    The metric name of the cloud monitor rule.
    metricUnit String
    The metric unit of the cloud monitor rule.
    period String
    The period of the cloud monitor rule.
    statistics String
    The statistics of the cloud monitor rule.
    threshold String
    The threshold of the cloud monitor rule.

    GetRulesRuleOriginalDimension

    Key string
    The key of the dimension.
    Values List<string>
    The value of the dimension.
    Key string
    The key of the dimension.
    Values []string
    The value of the dimension.
    key String
    The key of the dimension.
    values List<String>
    The value of the dimension.
    key string
    The key of the dimension.
    values string[]
    The value of the dimension.
    key str
    The key of the dimension.
    values Sequence[str]
    The value of the dimension.
    key String
    The key of the dimension.
    values List<String>
    The value of the dimension.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
    volcengine/pulumi-volcengine