1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vmp
  6. getAlertingRule
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.vmp.getAlertingRule

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::VMP::AlertingRule

    Using getAlertingRule

    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 getAlertingRule(args: GetAlertingRuleArgs, opts?: InvokeOptions): Promise<GetAlertingRuleResult>
function getAlertingRuleOutput(args: GetAlertingRuleOutputArgs, opts?: InvokeOptions): Output<GetAlertingRuleResult>
    def get_alerting_rule(id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetAlertingRuleResult
def get_alerting_rule_output(id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetAlertingRuleResult]
    func LookupAlertingRule(ctx *Context, args *LookupAlertingRuleArgs, opts ...InvokeOption) (*LookupAlertingRuleResult, error)
func LookupAlertingRuleOutput(ctx *Context, args *LookupAlertingRuleOutputArgs, opts ...InvokeOption) LookupAlertingRuleResultOutput

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

    public static class GetAlertingRule 
{
    public static Task<GetAlertingRuleResult> InvokeAsync(GetAlertingRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertingRuleResult> Invoke(GetAlertingRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAlertingRuleResult> getAlertingRule(GetAlertingRuleArgs args, InvokeOptions options)
public static Output<GetAlertingRuleResult> getAlertingRule(GetAlertingRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:vmp/getAlertingRule:getAlertingRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getAlertingRule Result

    The following output properties are available:

    AlertingRuleId string
    Alert rule ID
    Annotations List<Volcengine.GetAlertingRuleAnnotation>
    Annotation attached to the alert
    CreateTime string
    Alert rule creation time
    Description string
    Alert rule description
    Id string
    Uniquely identifies the resource.
    Labels List<Volcengine.GetAlertingRuleLabel>
    Tags attached to the alert
    Levels List<Volcengine.GetAlertingRuleLevel>
    Alert severity
    Name string
    Alert rule name
    NotifyGroupPolicyId string
    Alert aggregation policy ID
    NotifyPolicyId string
    Alert notification policy ID
    Query Volcengine.GetAlertingRuleQuery
    Alert configuration
    Status string
    Alert rule status: Running (monitoring), Disabled (disabled)
    Tags List<Volcengine.GetAlertingRuleTag>
    Tag
    Type string
    Alert rule type. Allowed values: vmp/PromQL
    UpdateTime string
    Alert rule update time
    AlertingRuleId string
    Alert rule ID
    Annotations []GetAlertingRuleAnnotation
    Annotation attached to the alert
    CreateTime string
    Alert rule creation time
    Description string
    Alert rule description
    Id string
    Uniquely identifies the resource.
    Labels []GetAlertingRuleLabel
    Tags attached to the alert
    Levels []GetAlertingRuleLevel
    Alert severity
    Name string
    Alert rule name
    NotifyGroupPolicyId string
    Alert aggregation policy ID
    NotifyPolicyId string
    Alert notification policy ID
    Query GetAlertingRuleQuery
    Alert configuration
    Status string
    Alert rule status: Running (monitoring), Disabled (disabled)
    Tags []GetAlertingRuleTag
    Tag
    Type string
    Alert rule type. Allowed values: vmp/PromQL
    UpdateTime string
    Alert rule update time
    alertingRuleId String
    Alert rule ID
    annotations List<GetAlertingRuleAnnotation>
    Annotation attached to the alert
    createTime String
    Alert rule creation time
    description String
    Alert rule description
    id String
    Uniquely identifies the resource.
    labels List<GetAlertingRuleLabel>
    Tags attached to the alert
    levels List<GetAlertingRuleLevel>
    Alert severity
    name String
    Alert rule name
    notifyGroupPolicyId String
    Alert aggregation policy ID
    notifyPolicyId String
    Alert notification policy ID
    query GetAlertingRuleQuery
    Alert configuration
    status String
    Alert rule status: Running (monitoring), Disabled (disabled)
    tags List<GetAlertingRuleTag>
    Tag
    type String
    Alert rule type. Allowed values: vmp/PromQL
    updateTime String
    Alert rule update time
    alertingRuleId string
    Alert rule ID
    annotations GetAlertingRuleAnnotation[]
    Annotation attached to the alert
    createTime string
    Alert rule creation time
    description string
    Alert rule description
    id string
    Uniquely identifies the resource.
    labels GetAlertingRuleLabel[]
    Tags attached to the alert
    levels GetAlertingRuleLevel[]
    Alert severity
    name string
    Alert rule name
    notifyGroupPolicyId string
    Alert aggregation policy ID
    notifyPolicyId string
    Alert notification policy ID
    query GetAlertingRuleQuery
    Alert configuration
    status string
    Alert rule status: Running (monitoring), Disabled (disabled)
    tags GetAlertingRuleTag[]
    Tag
    type string
    Alert rule type. Allowed values: vmp/PromQL
    updateTime string
    Alert rule update time
    alerting_rule_id str
    Alert rule ID
    annotations Sequence[GetAlertingRuleAnnotation]
    Annotation attached to the alert
    create_time str
    Alert rule creation time
    description str
    Alert rule description
    id str
    Uniquely identifies the resource.
    labels Sequence[GetAlertingRuleLabel]
    Tags attached to the alert
    levels Sequence[GetAlertingRuleLevel]
    Alert severity
    name str
    Alert rule name
    notify_group_policy_id str
    Alert aggregation policy ID
    notify_policy_id str
    Alert notification policy ID
    query GetAlertingRuleQuery
    Alert configuration
    status str
    Alert rule status: Running (monitoring), Disabled (disabled)
    tags Sequence[GetAlertingRuleTag]
    Tag
    type str
    Alert rule type. Allowed values: vmp/PromQL
    update_time str
    Alert rule update time
    alertingRuleId String
    Alert rule ID
    annotations List<Property Map>
    Annotation attached to the alert
    createTime String
    Alert rule creation time
    description String
    Alert rule description
    id String
    Uniquely identifies the resource.
    labels List<Property Map>
    Tags attached to the alert
    levels List<Property Map>
    Alert severity
    name String
    Alert rule name
    notifyGroupPolicyId String
    Alert aggregation policy ID
    notifyPolicyId String
    Alert notification policy ID
    query Property Map
    Alert configuration
    status String
    Alert rule status: Running (monitoring), Disabled (disabled)
    tags List<Property Map>
    Tag
    type String
    Alert rule type. Allowed values: vmp/PromQL
    updateTime String
    Alert rule update time

    Supporting Types

    GetAlertingRuleAnnotation

    Name string
    Tag or annotation key
    Value string
    Tag or annotation value. If set to empty, the key will be deleted
    Name string
    Tag or annotation key
    Value string
    Tag or annotation value. If set to empty, the key will be deleted
    name String
    Tag or annotation key
    value String
    Tag or annotation value. If set to empty, the key will be deleted
    name string
    Tag or annotation key
    value string
    Tag or annotation value. If set to empty, the key will be deleted
    name str
    Tag or annotation key
    value str
    Tag or annotation value. If set to empty, the key will be deleted
    name String
    Tag or annotation key
    value String
    Tag or annotation value. If set to empty, the key will be deleted

    GetAlertingRuleLabel

    Name string
    Tag or annotation key
    Value string
    Tag or annotation value. If set to empty, the key will be deleted
    Name string
    Tag or annotation key
    Value string
    Tag or annotation value. If set to empty, the key will be deleted
    name String
    Tag or annotation key
    value String
    Tag or annotation value. If set to empty, the key will be deleted
    name string
    Tag or annotation key
    value string
    Tag or annotation value. If set to empty, the key will be deleted
    name str
    Tag or annotation key
    value str
    Tag or annotation value. If set to empty, the key will be deleted
    name String
    Tag or annotation key
    value String
    Tag or annotation value. If set to empty, the key will be deleted

    GetAlertingRuleLevel

    Comparator string
    Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
    For string
    Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
    Level string
    Alert rule severity. Currently supports P0, P1, or P2
    Threshold double
    Alert rule threshold
    Comparator string
    Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
    For string
    Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
    Level string
    Alert rule severity. Currently supports P0, P1, or P2
    Threshold float64
    Alert rule threshold
    comparator String
    Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
    for_ String
    Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
    level String
    Alert rule severity. Currently supports P0, P1, or P2
    threshold Double
    Alert rule threshold
    comparator string
    Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
    for string
    Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
    level string
    Alert rule severity. Currently supports P0, P1, or P2
    threshold number
    Alert rule threshold
    comparator str
    Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
    for_ str
    Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
    level str
    Alert rule severity. Currently supports P0, P1, or P2
    threshold float
    Alert rule threshold
    comparator String
    Alert rule comparison condition. Options: >, >=, <, <=, ==, !=
    for String
    Alert duration. Possible values: 0s, 1m, 2m, 5m, 10m
    level String
    Alert rule severity. Currently supports P0, P1, or P2
    threshold Number
    Alert rule threshold

    GetAlertingRuleQuery

    PromQl string
    Query statement
    WorkspaceId string
    Workspace ID
    PromQl string
    Query statement
    WorkspaceId string
    Workspace ID
    promQl String
    Query statement
    workspaceId String
    Workspace ID
    promQl string
    Query statement
    workspaceId string
    Workspace ID
    prom_ql str
    Query statement
    workspace_id str
    Workspace ID
    promQl String
    Query statement
    workspaceId String
    Workspace ID

    GetAlertingRuleTag

    Key string
    Tag or annotation key
    Value string
    Tag or annotation value. If set to empty, the key will be deleted
    Key string
    Tag or annotation key
    Value string
    Tag or annotation value. If set to empty, the key will be deleted
    key String
    Tag or annotation key
    value String
    Tag or annotation value. If set to empty, the key will be deleted
    key string
    Tag or annotation key
    value string
    Tag or annotation value. If set to empty, the key will be deleted
    key str
    Tag or annotation key
    value str
    Tag or annotation value. If set to empty, the key will be deleted
    key String
    Tag or annotation key
    value String
    Tag or annotation value. If set to empty, the key will be deleted

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.