1. Packages
  2. Alicloud Provider
  3. API Docs
  4. cms
  5. getMetricRuleBlackLists
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi

alicloud.cms.getMetricRuleBlackLists

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi

    This data source provides Cloud Monitor Service Metric Rule Black List available to the user.What is Metric Rule Black List

    NOTE: Available in 1.194.0+

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const default = alicloud.cms.getMetricRuleBlackLists({
        ids: [defaultAlicloudCmsMetricRuleBlackLists.id],
        category: "ecs",
        namespace: "acs_ecs_dashboard",
    });
    export const alicloudCmsRuleBlackListExampleId = lists[0].id;
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    default = alicloud.cms.get_metric_rule_black_lists(ids=[default_alicloud_cms_metric_rule_black_lists["id"]],
        category="ecs",
        namespace="acs_ecs_dashboard")
    pulumi.export("alicloudCmsRuleBlackListExampleId", lists[0]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cms"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
    _, err := cms.GetMetricRuleBlackLists(ctx, &cms.GetMetricRuleBlackListsArgs{
    Ids: interface{}{
    defaultAlicloudCmsMetricRuleBlackLists.Id,
    },
    Category: pulumi.StringRef("ecs"),
    Namespace: pulumi.StringRef("acs_ecs_dashboard"),
    }, nil);
    if err != nil {
    return err
    }
    ctx.Export("alicloudCmsRuleBlackListExampleId", lists[0].Id)
    return nil
    })
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = AliCloud.Cms.GetMetricRuleBlackLists.Invoke(new()
        {
            Ids = new[]
            {
                defaultAlicloudCmsMetricRuleBlackLists.Id,
            },
            Category = "ecs",
            Namespace = "acs_ecs_dashboard",
        });
    
        return new Dictionary<string, object?>
        {
            ["alicloudCmsRuleBlackListExampleId"] = lists[0].Id,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.cms.CmsFunctions;
    import com.pulumi.alicloud.cms.inputs.GetMetricRuleBlackListsArgs;
    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 = CmsFunctions.getMetricRuleBlackLists(GetMetricRuleBlackListsArgs.builder()
                .ids(defaultAlicloudCmsMetricRuleBlackLists.id())
                .category("ecs")
                .namespace("acs_ecs_dashboard")
                .build());
    
            ctx.export("alicloudCmsRuleBlackListExampleId", lists[0].id());
        }
    }
    
    variables:
      default:
        fn::invoke:
          Function: alicloud:cms:getMetricRuleBlackLists
          Arguments:
            ids:
              - ${defaultAlicloudCmsMetricRuleBlackLists.id}
            category: ecs
            namespace: acs_ecs_dashboard
    outputs:
      alicloudCmsRuleBlackListExampleId: ${lists[0].id}
    

    Using getMetricRuleBlackLists

    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 getMetricRuleBlackLists(args: GetMetricRuleBlackListsArgs, opts?: InvokeOptions): Promise<GetMetricRuleBlackListsResult>
    function getMetricRuleBlackListsOutput(args: GetMetricRuleBlackListsOutputArgs, opts?: InvokeOptions): Output<GetMetricRuleBlackListsResult>
    def get_metric_rule_black_lists(category: Optional[str] = None,
                                    ids: Optional[Sequence[str]] = None,
                                    metric_rule_black_list_id: Optional[str] = None,
                                    name_regex: Optional[str] = None,
                                    namespace: Optional[str] = None,
                                    order: Optional[int] = None,
                                    output_file: Optional[str] = None,
                                    page_number: Optional[int] = None,
                                    page_size: Optional[int] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetMetricRuleBlackListsResult
    def get_metric_rule_black_lists_output(category: Optional[pulumi.Input[str]] = None,
                                    ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                    metric_rule_black_list_id: Optional[pulumi.Input[str]] = None,
                                    name_regex: Optional[pulumi.Input[str]] = None,
                                    namespace: Optional[pulumi.Input[str]] = None,
                                    order: Optional[pulumi.Input[int]] = None,
                                    output_file: Optional[pulumi.Input[str]] = None,
                                    page_number: Optional[pulumi.Input[int]] = None,
                                    page_size: Optional[pulumi.Input[int]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetMetricRuleBlackListsResult]
    func GetMetricRuleBlackLists(ctx *Context, args *GetMetricRuleBlackListsArgs, opts ...InvokeOption) (*GetMetricRuleBlackListsResult, error)
    func GetMetricRuleBlackListsOutput(ctx *Context, args *GetMetricRuleBlackListsOutputArgs, opts ...InvokeOption) GetMetricRuleBlackListsResultOutput

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

    public static class GetMetricRuleBlackLists 
    {
        public static Task<GetMetricRuleBlackListsResult> InvokeAsync(GetMetricRuleBlackListsArgs args, InvokeOptions? opts = null)
        public static Output<GetMetricRuleBlackListsResult> Invoke(GetMetricRuleBlackListsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMetricRuleBlackListsResult> getMetricRuleBlackLists(GetMetricRuleBlackListsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: alicloud:cms/getMetricRuleBlackLists:getMetricRuleBlackLists
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Category string
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    Ids List<string>
    A list of Metric Rule Black List IDs.
    MetricRuleBlackListId string
    The first ID of the resource
    NameRegex string
    A regex string to filter results by Group Metric Rule name.
    Namespace string
    The data namespace of the cloud service.
    Order int
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    PageNumber int
    PageSize int
    Category string
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    Ids []string
    A list of Metric Rule Black List IDs.
    MetricRuleBlackListId string
    The first ID of the resource
    NameRegex string
    A regex string to filter results by Group Metric Rule name.
    Namespace string
    The data namespace of the cloud service.
    Order int
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    PageNumber int
    PageSize int
    category String
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    ids List<String>
    A list of Metric Rule Black List IDs.
    metricRuleBlackListId String
    The first ID of the resource
    nameRegex String
    A regex string to filter results by Group Metric Rule name.
    namespace String
    The data namespace of the cloud service.
    order Integer
    outputFile String
    File name where to save data source results (after running pulumi preview).
    pageNumber Integer
    pageSize Integer
    category string
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    ids string[]
    A list of Metric Rule Black List IDs.
    metricRuleBlackListId string
    The first ID of the resource
    nameRegex string
    A regex string to filter results by Group Metric Rule name.
    namespace string
    The data namespace of the cloud service.
    order number
    outputFile string
    File name where to save data source results (after running pulumi preview).
    pageNumber number
    pageSize number
    category str
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    ids Sequence[str]
    A list of Metric Rule Black List IDs.
    metric_rule_black_list_id str
    The first ID of the resource
    name_regex str
    A regex string to filter results by Group Metric Rule name.
    namespace str
    The data namespace of the cloud service.
    order int
    output_file str
    File name where to save data source results (after running pulumi preview).
    page_number int
    page_size int
    category String
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    ids List<String>
    A list of Metric Rule Black List IDs.
    metricRuleBlackListId String
    The first ID of the resource
    nameRegex String
    A regex string to filter results by Group Metric Rule name.
    namespace String
    The data namespace of the cloud service.
    order Number
    outputFile String
    File name where to save data source results (after running pulumi preview).
    pageNumber Number
    pageSize Number

    getMetricRuleBlackLists Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    A list of Metric Rule Black List IDs.
    Lists List<Pulumi.AliCloud.Cms.Outputs.GetMetricRuleBlackListsList>
    A list of Metric Rule Black List Entries. Each element contains the following attributes:
    Names List<string>
    A list of name of Metric Rule Black Lists.
    Category string
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    MetricRuleBlackListId string
    The first ID of the resource
    NameRegex string
    Namespace string
    The data namespace of the cloud service.
    Order int
    OutputFile string
    PageNumber int
    PageSize int
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    A list of Metric Rule Black List IDs.
    Lists []GetMetricRuleBlackListsList
    A list of Metric Rule Black List Entries. Each element contains the following attributes:
    Names []string
    A list of name of Metric Rule Black Lists.
    Category string
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    MetricRuleBlackListId string
    The first ID of the resource
    NameRegex string
    Namespace string
    The data namespace of the cloud service.
    Order int
    OutputFile string
    PageNumber int
    PageSize int
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of Metric Rule Black List IDs.
    lists List<GetMetricRuleBlackListsList>
    A list of Metric Rule Black List Entries. Each element contains the following attributes:
    names List<String>
    A list of name of Metric Rule Black Lists.
    category String
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    metricRuleBlackListId String
    The first ID of the resource
    nameRegex String
    namespace String
    The data namespace of the cloud service.
    order Integer
    outputFile String
    pageNumber Integer
    pageSize Integer
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    A list of Metric Rule Black List IDs.
    lists GetMetricRuleBlackListsList[]
    A list of Metric Rule Black List Entries. Each element contains the following attributes:
    names string[]
    A list of name of Metric Rule Black Lists.
    category string
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    metricRuleBlackListId string
    The first ID of the resource
    nameRegex string
    namespace string
    The data namespace of the cloud service.
    order number
    outputFile string
    pageNumber number
    pageSize number
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    A list of Metric Rule Black List IDs.
    lists Sequence[GetMetricRuleBlackListsList]
    A list of Metric Rule Black List Entries. Each element contains the following attributes:
    names Sequence[str]
    A list of name of Metric Rule Black Lists.
    category str
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    metric_rule_black_list_id str
    The first ID of the resource
    name_regex str
    namespace str
    The data namespace of the cloud service.
    order int
    output_file str
    page_number int
    page_size int
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of Metric Rule Black List IDs.
    lists List<Property Map>
    A list of Metric Rule Black List Entries. Each element contains the following attributes:
    names List<String>
    A list of name of Metric Rule Black Lists.
    category String
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    metricRuleBlackListId String
    The first ID of the resource
    nameRegex String
    namespace String
    The data namespace of the cloud service.
    order Number
    outputFile String
    pageNumber Number
    pageSize Number

    Supporting Types

    GetMetricRuleBlackListsList

    Category string
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    CreateTime string
    The timestamp for creating an alert blacklist policy.Unit: milliseconds.
    EffectiveTime string
    The effective time range of the alert blacklist policy.
    EnableEndTime string
    The start timestamp of the alert blacklist policy.Unit: milliseconds.
    EnableStartTime string
    The end timestamp of the alert blacklist policy.Unit: milliseconds.
    Id string
    Instances List<string>
    The list of instances of cloud services specified in the alert blacklist policy.
    IsEnable bool
    The status of the alert blacklist policy. Value:-true: enabled.-false: disabled.
    MetricRuleBlackListId string
    The first ID of the resource
    MetricRuleBlackListName string
    The name of the alert blacklist policy.
    Metrics List<Pulumi.AliCloud.Cms.Inputs.GetMetricRuleBlackListsListMetric>
    Monitoring metrics in the instance.
    Namespace string
    The data namespace of the cloud service.
    ScopeType string
    The effective range of the alert blacklist policy. Value:-USER: The alert blacklist policy only takes effect in the current Alibaba cloud account.-GROUP: The alert blacklist policy takes effect in the specified application GROUP.
    ScopeValues List<string>
    Application Group ID list. The format is JSON Array.> This parameter is displayed only when 'ScopeType' is 'GROUP.
    Category string
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    CreateTime string
    The timestamp for creating an alert blacklist policy.Unit: milliseconds.
    EffectiveTime string
    The effective time range of the alert blacklist policy.
    EnableEndTime string
    The start timestamp of the alert blacklist policy.Unit: milliseconds.
    EnableStartTime string
    The end timestamp of the alert blacklist policy.Unit: milliseconds.
    Id string
    Instances []string
    The list of instances of cloud services specified in the alert blacklist policy.
    IsEnable bool
    The status of the alert blacklist policy. Value:-true: enabled.-false: disabled.
    MetricRuleBlackListId string
    The first ID of the resource
    MetricRuleBlackListName string
    The name of the alert blacklist policy.
    Metrics []GetMetricRuleBlackListsListMetric
    Monitoring metrics in the instance.
    Namespace string
    The data namespace of the cloud service.
    ScopeType string
    The effective range of the alert blacklist policy. Value:-USER: The alert blacklist policy only takes effect in the current Alibaba cloud account.-GROUP: The alert blacklist policy takes effect in the specified application GROUP.
    ScopeValues []string
    Application Group ID list. The format is JSON Array.> This parameter is displayed only when 'ScopeType' is 'GROUP.
    category String
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    createTime String
    The timestamp for creating an alert blacklist policy.Unit: milliseconds.
    effectiveTime String
    The effective time range of the alert blacklist policy.
    enableEndTime String
    The start timestamp of the alert blacklist policy.Unit: milliseconds.
    enableStartTime String
    The end timestamp of the alert blacklist policy.Unit: milliseconds.
    id String
    instances List<String>
    The list of instances of cloud services specified in the alert blacklist policy.
    isEnable Boolean
    The status of the alert blacklist policy. Value:-true: enabled.-false: disabled.
    metricRuleBlackListId String
    The first ID of the resource
    metricRuleBlackListName String
    The name of the alert blacklist policy.
    metrics List<GetMetricRuleBlackListsListMetric>
    Monitoring metrics in the instance.
    namespace String
    The data namespace of the cloud service.
    scopeType String
    The effective range of the alert blacklist policy. Value:-USER: The alert blacklist policy only takes effect in the current Alibaba cloud account.-GROUP: The alert blacklist policy takes effect in the specified application GROUP.
    scopeValues List<String>
    Application Group ID list. The format is JSON Array.> This parameter is displayed only when 'ScopeType' is 'GROUP.
    category string
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    createTime string
    The timestamp for creating an alert blacklist policy.Unit: milliseconds.
    effectiveTime string
    The effective time range of the alert blacklist policy.
    enableEndTime string
    The start timestamp of the alert blacklist policy.Unit: milliseconds.
    enableStartTime string
    The end timestamp of the alert blacklist policy.Unit: milliseconds.
    id string
    instances string[]
    The list of instances of cloud services specified in the alert blacklist policy.
    isEnable boolean
    The status of the alert blacklist policy. Value:-true: enabled.-false: disabled.
    metricRuleBlackListId string
    The first ID of the resource
    metricRuleBlackListName string
    The name of the alert blacklist policy.
    metrics GetMetricRuleBlackListsListMetric[]
    Monitoring metrics in the instance.
    namespace string
    The data namespace of the cloud service.
    scopeType string
    The effective range of the alert blacklist policy. Value:-USER: The alert blacklist policy only takes effect in the current Alibaba cloud account.-GROUP: The alert blacklist policy takes effect in the specified application GROUP.
    scopeValues string[]
    Application Group ID list. The format is JSON Array.> This parameter is displayed only when 'ScopeType' is 'GROUP.
    category str
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    create_time str
    The timestamp for creating an alert blacklist policy.Unit: milliseconds.
    effective_time str
    The effective time range of the alert blacklist policy.
    enable_end_time str
    The start timestamp of the alert blacklist policy.Unit: milliseconds.
    enable_start_time str
    The end timestamp of the alert blacklist policy.Unit: milliseconds.
    id str
    instances Sequence[str]
    The list of instances of cloud services specified in the alert blacklist policy.
    is_enable bool
    The status of the alert blacklist policy. Value:-true: enabled.-false: disabled.
    metric_rule_black_list_id str
    The first ID of the resource
    metric_rule_black_list_name str
    The name of the alert blacklist policy.
    metrics Sequence[GetMetricRuleBlackListsListMetric]
    Monitoring metrics in the instance.
    namespace str
    The data namespace of the cloud service.
    scope_type str
    The effective range of the alert blacklist policy. Value:-USER: The alert blacklist policy only takes effect in the current Alibaba cloud account.-GROUP: The alert blacklist policy takes effect in the specified application GROUP.
    scope_values Sequence[str]
    Application Group ID list. The format is JSON Array.> This parameter is displayed only when 'ScopeType' is 'GROUP.
    category String
    Cloud service classification. For example, Redis includes kvstore_standard, kvstore_sharding, and kvstore_splitrw.
    createTime String
    The timestamp for creating an alert blacklist policy.Unit: milliseconds.
    effectiveTime String
    The effective time range of the alert blacklist policy.
    enableEndTime String
    The start timestamp of the alert blacklist policy.Unit: milliseconds.
    enableStartTime String
    The end timestamp of the alert blacklist policy.Unit: milliseconds.
    id String
    instances List<String>
    The list of instances of cloud services specified in the alert blacklist policy.
    isEnable Boolean
    The status of the alert blacklist policy. Value:-true: enabled.-false: disabled.
    metricRuleBlackListId String
    The first ID of the resource
    metricRuleBlackListName String
    The name of the alert blacklist policy.
    metrics List<Property Map>
    Monitoring metrics in the instance.
    namespace String
    The data namespace of the cloud service.
    scopeType String
    The effective range of the alert blacklist policy. Value:-USER: The alert blacklist policy only takes effect in the current Alibaba cloud account.-GROUP: The alert blacklist policy takes effect in the specified application GROUP.
    scopeValues List<String>
    Application Group ID list. The format is JSON Array.> This parameter is displayed only when 'ScopeType' is 'GROUP.

    GetMetricRuleBlackListsListMetric

    MetricName string
    The name of the monitoring indicator.
    Resource string
    The extended dimension information of the instance. For example, '{"device":"C:"}' indicates that the blacklist policy is applied to all C disks under the ECS instance.
    MetricName string
    The name of the monitoring indicator.
    Resource string
    The extended dimension information of the instance. For example, '{"device":"C:"}' indicates that the blacklist policy is applied to all C disks under the ECS instance.
    metricName String
    The name of the monitoring indicator.
    resource String
    The extended dimension information of the instance. For example, '{"device":"C:"}' indicates that the blacklist policy is applied to all C disks under the ECS instance.
    metricName string
    The name of the monitoring indicator.
    resource string
    The extended dimension information of the instance. For example, '{"device":"C:"}' indicates that the blacklist policy is applied to all C disks under the ECS instance.
    metric_name str
    The name of the monitoring indicator.
    resource str
    The extended dimension information of the instance. For example, '{"device":"C:"}' indicates that the blacklist policy is applied to all C disks under the ECS instance.
    metricName String
    The name of the monitoring indicator.
    resource String
    The extended dimension information of the instance. For example, '{"device":"C:"}' indicates that the blacklist policy is applied to all C disks under the ECS instance.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi