1. Packages
  2. Volcengine
  3. API Docs
  4. waf
  5. getAclRules
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine

volcengine.waf.getAclRules

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine

    Use this data source to query detailed information of waf acl rules

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    
    const foo = volcengine.waf.getAclRules({
        aclType: "Block",
        actions: ["observe"],
        defenceHosts: ["www.tf-test.com"],
        enables: [1],
        projectName: "default",
        ruleName: "tf-test",
        timeOrderBy: "ASC",
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.waf.get_acl_rules(acl_type="Block",
        actions=["observe"],
        defence_hosts=["www.tf-test.com"],
        enables=[1],
        project_name="default",
        rule_name="tf-test",
        time_order_by="ASC")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/waf"
    )
    func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
    _, err := waf.GetAclRules(ctx, &waf.GetAclRulesArgs{
    AclType: "Block",
    Actions: []string{
    "observe",
    },
    DefenceHosts: []string{
    "www.tf-test.com",
    },
    Enables: interface{}{
    1,
    },
    ProjectName: pulumi.StringRef("default"),
    RuleName: pulumi.StringRef("tf-test"),
    TimeOrderBy: pulumi.StringRef("ASC"),
    }, 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.Waf.GetAclRules.Invoke(new()
        {
            AclType = "Block",
            Actions = new[]
            {
                "observe",
            },
            DefenceHosts = new[]
            {
                "www.tf-test.com",
            },
            Enables = new[]
            {
                1,
            },
            ProjectName = "default",
            RuleName = "tf-test",
            TimeOrderBy = "ASC",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.waf.WafFunctions;
    import com.pulumi.volcengine.waf.inputs.GetAclRulesArgs;
    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 = WafFunctions.getAclRules(GetAclRulesArgs.builder()
                .aclType("Block")
                .actions("observe")
                .defenceHosts("www.tf-test.com")
                .enables(1)
                .projectName("default")
                .ruleName("tf-test")
                .timeOrderBy("ASC")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: volcengine:waf:getAclRules
          Arguments:
            aclType: Block
            actions:
              - observe
            defenceHosts:
              - www.tf-test.com
            enables:
              - 1
            projectName: default
            ruleName: tf-test
            timeOrderBy: ASC
    

    Using getAclRules

    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 getAclRules(args: GetAclRulesArgs, opts?: InvokeOptions): Promise<GetAclRulesResult>
    function getAclRulesOutput(args: GetAclRulesOutputArgs, opts?: InvokeOptions): Output<GetAclRulesResult>
    def get_acl_rules(acl_type: Optional[str] = None,
                      actions: Optional[Sequence[str]] = None,
                      defence_hosts: Optional[Sequence[str]] = None,
                      enables: Optional[Sequence[int]] = None,
                      name_regex: Optional[str] = None,
                      output_file: Optional[str] = None,
                      project_name: Optional[str] = None,
                      rule_name: Optional[str] = None,
                      rule_tag: Optional[str] = None,
                      time_order_by: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetAclRulesResult
    def get_acl_rules_output(acl_type: Optional[pulumi.Input[str]] = None,
                      actions: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      defence_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      enables: Optional[pulumi.Input[Sequence[pulumi.Input[int]]]] = None,
                      name_regex: Optional[pulumi.Input[str]] = None,
                      output_file: Optional[pulumi.Input[str]] = None,
                      project_name: Optional[pulumi.Input[str]] = None,
                      rule_name: Optional[pulumi.Input[str]] = None,
                      rule_tag: Optional[pulumi.Input[str]] = None,
                      time_order_by: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetAclRulesResult]
    func GetAclRules(ctx *Context, args *GetAclRulesArgs, opts ...InvokeOption) (*GetAclRulesResult, error)
    func GetAclRulesOutput(ctx *Context, args *GetAclRulesOutputArgs, opts ...InvokeOption) GetAclRulesResultOutput

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

    public static class GetAclRules 
    {
        public static Task<GetAclRulesResult> InvokeAsync(GetAclRulesArgs args, InvokeOptions? opts = null)
        public static Output<GetAclRulesResult> Invoke(GetAclRulesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAclRulesResult> getAclRules(GetAclRulesArgs args, InvokeOptions options)
    public static Output<GetAclRulesResult> getAclRules(GetAclRulesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:waf/getAclRules:getAclRules
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AclType string
    The types of access control rules.
    Actions List<string>
    Action to be taken on requests that match the rule.
    DefenceHosts List<string>
    The list of queried domain names.
    Enables List<int>
    The enabled status of the rule.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The name of the project to which your domain names belong.
    RuleName string
    Rule name, fuzzy search.
    RuleTag string
    Rule unique identifier, precise search.
    TimeOrderBy string
    The list shows the timing sequence.
    AclType string
    The types of access control rules.
    Actions []string
    Action to be taken on requests that match the rule.
    DefenceHosts []string
    The list of queried domain names.
    Enables []int
    The enabled status of the rule.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The name of the project to which your domain names belong.
    RuleName string
    Rule name, fuzzy search.
    RuleTag string
    Rule unique identifier, precise search.
    TimeOrderBy string
    The list shows the timing sequence.
    aclType String
    The types of access control rules.
    actions List<String>
    Action to be taken on requests that match the rule.
    defenceHosts List<String>
    The list of queried domain names.
    enables List<Integer>
    The enabled status of the rule.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    projectName String
    The name of the project to which your domain names belong.
    ruleName String
    Rule name, fuzzy search.
    ruleTag String
    Rule unique identifier, precise search.
    timeOrderBy String
    The list shows the timing sequence.
    aclType string
    The types of access control rules.
    actions string[]
    Action to be taken on requests that match the rule.
    defenceHosts string[]
    The list of queried domain names.
    enables number[]
    The enabled status of the rule.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    projectName string
    The name of the project to which your domain names belong.
    ruleName string
    Rule name, fuzzy search.
    ruleTag string
    Rule unique identifier, precise search.
    timeOrderBy string
    The list shows the timing sequence.
    acl_type str
    The types of access control rules.
    actions Sequence[str]
    Action to be taken on requests that match the rule.
    defence_hosts Sequence[str]
    The list of queried domain names.
    enables Sequence[int]
    The enabled status of the rule.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    project_name str
    The name of the project to which your domain names belong.
    rule_name str
    Rule name, fuzzy search.
    rule_tag str
    Rule unique identifier, precise search.
    time_order_by str
    The list shows the timing sequence.
    aclType String
    The types of access control rules.
    actions List<String>
    Action to be taken on requests that match the rule.
    defenceHosts List<String>
    The list of queried domain names.
    enables List<Number>
    The enabled status of the rule.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    projectName String
    The name of the project to which your domain names belong.
    ruleName String
    Rule name, fuzzy search.
    ruleTag String
    Rule unique identifier, precise search.
    timeOrderBy String
    The list shows the timing sequence.

    getAclRules Result

    The following output properties are available:

    AclType string
    Id string
    The provider-assigned unique ID for this managed resource.
    Rules List<GetAclRulesRule>
    Details of the rules.
    TotalCount int
    The total count of query.
    Actions List<string>
    Action to be taken on requests that match the rule.
    DefenceHosts List<string>
    Enables List<int>
    Whether to enable the rule.
    NameRegex string
    OutputFile string
    ProjectName string
    RuleName string
    RuleTag string
    Rule unique identifier.
    TimeOrderBy string
    AclType string
    Id string
    The provider-assigned unique ID for this managed resource.
    Rules []GetAclRulesRule
    Details of the rules.
    TotalCount int
    The total count of query.
    Actions []string
    Action to be taken on requests that match the rule.
    DefenceHosts []string
    Enables []int
    Whether to enable the rule.
    NameRegex string
    OutputFile string
    ProjectName string
    RuleName string
    RuleTag string
    Rule unique identifier.
    TimeOrderBy string
    aclType String
    id String
    The provider-assigned unique ID for this managed resource.
    rules List<GetAclRulesRule>
    Details of the rules.
    totalCount Integer
    The total count of query.
    actions List<String>
    Action to be taken on requests that match the rule.
    defenceHosts List<String>
    enables List<Integer>
    Whether to enable the rule.
    nameRegex String
    outputFile String
    projectName String
    ruleName String
    ruleTag String
    Rule unique identifier.
    timeOrderBy String
    aclType string
    id string
    The provider-assigned unique ID for this managed resource.
    rules GetAclRulesRule[]
    Details of the rules.
    totalCount number
    The total count of query.
    actions string[]
    Action to be taken on requests that match the rule.
    defenceHosts string[]
    enables number[]
    Whether to enable the rule.
    nameRegex string
    outputFile string
    projectName string
    ruleName string
    ruleTag string
    Rule unique identifier.
    timeOrderBy string
    acl_type str
    id str
    The provider-assigned unique ID for this managed resource.
    rules Sequence[GetAclRulesRule]
    Details of the rules.
    total_count int
    The total count of query.
    actions Sequence[str]
    Action to be taken on requests that match the rule.
    defence_hosts Sequence[str]
    enables Sequence[int]
    Whether to enable the rule.
    name_regex str
    output_file str
    project_name str
    rule_name str
    rule_tag str
    Rule unique identifier.
    time_order_by str
    aclType String
    id String
    The provider-assigned unique ID for this managed resource.
    rules List<Property Map>
    Details of the rules.
    totalCount Number
    The total count of query.
    actions List<String>
    Action to be taken on requests that match the rule.
    defenceHosts List<String>
    enables List<Number>
    Whether to enable the rule.
    nameRegex String
    outputFile String
    projectName String
    ruleName String
    ruleTag String
    Rule unique identifier.
    timeOrderBy String

    Supporting Types

    GetAclRulesRule

    AccurateGroup GetAclRulesRuleAccurateGroup
    Advanced conditions.
    Action string
    Action to be taken on requests that match the rule.
    Advanced int
    Whether to set advanced conditions.
    ClientIp string
    IP address.
    Description string
    Rule description.
    Enable int
    The enabled status of the rule.
    HostAddType int
    Type of domain name addition.
    HostGroupIds List<int>
    The ID of host group.
    HostGroups List<GetAclRulesRuleHostGroup>
    The list of domain name groups.
    HostLists List<string>
    Single or multiple domain names are supported.
    Id int
    Rule ID.
    IpAddType int
    Type of IP address addition.
    IpGroupIds List<int>
    The ID of the IP address group.
    IpGroups List<GetAclRulesRuleIpGroup>
    The list of domain name groups.
    IpLists List<string>
    Single or multiple IP addresses are supported.
    IpLocationCountries List<string>
    Country or region code.
    IpLocationSubregions List<string>
    Domestic region code.
    Name string
    Rule name.
    RuleTag string
    Rule unique identifier, precise search.
    UpdateTime string
    Update time of the rule.
    Url string
    The path of Matching.
    AccurateGroup GetAclRulesRuleAccurateGroup
    Advanced conditions.
    Action string
    Action to be taken on requests that match the rule.
    Advanced int
    Whether to set advanced conditions.
    ClientIp string
    IP address.
    Description string
    Rule description.
    Enable int
    The enabled status of the rule.
    HostAddType int
    Type of domain name addition.
    HostGroupIds []int
    The ID of host group.
    HostGroups []GetAclRulesRuleHostGroup
    The list of domain name groups.
    HostLists []string
    Single or multiple domain names are supported.
    Id int
    Rule ID.
    IpAddType int
    Type of IP address addition.
    IpGroupIds []int
    The ID of the IP address group.
    IpGroups []GetAclRulesRuleIpGroup
    The list of domain name groups.
    IpLists []string
    Single or multiple IP addresses are supported.
    IpLocationCountries []string
    Country or region code.
    IpLocationSubregions []string
    Domestic region code.
    Name string
    Rule name.
    RuleTag string
    Rule unique identifier, precise search.
    UpdateTime string
    Update time of the rule.
    Url string
    The path of Matching.
    accurateGroup GetAclRulesRuleAccurateGroup
    Advanced conditions.
    action String
    Action to be taken on requests that match the rule.
    advanced Integer
    Whether to set advanced conditions.
    clientIp String
    IP address.
    description String
    Rule description.
    enable Integer
    The enabled status of the rule.
    hostAddType Integer
    Type of domain name addition.
    hostGroupIds List<Integer>
    The ID of host group.
    hostGroups List<GetAclRulesRuleHostGroup>
    The list of domain name groups.
    hostLists List<String>
    Single or multiple domain names are supported.
    id Integer
    Rule ID.
    ipAddType Integer
    Type of IP address addition.
    ipGroupIds List<Integer>
    The ID of the IP address group.
    ipGroups List<GetAclRulesRuleIpGroup>
    The list of domain name groups.
    ipLists List<String>
    Single or multiple IP addresses are supported.
    ipLocationCountries List<String>
    Country or region code.
    ipLocationSubregions List<String>
    Domestic region code.
    name String
    Rule name.
    ruleTag String
    Rule unique identifier, precise search.
    updateTime String
    Update time of the rule.
    url String
    The path of Matching.
    accurateGroup GetAclRulesRuleAccurateGroup
    Advanced conditions.
    action string
    Action to be taken on requests that match the rule.
    advanced number
    Whether to set advanced conditions.
    clientIp string
    IP address.
    description string
    Rule description.
    enable number
    The enabled status of the rule.
    hostAddType number
    Type of domain name addition.
    hostGroupIds number[]
    The ID of host group.
    hostGroups GetAclRulesRuleHostGroup[]
    The list of domain name groups.
    hostLists string[]
    Single or multiple domain names are supported.
    id number
    Rule ID.
    ipAddType number
    Type of IP address addition.
    ipGroupIds number[]
    The ID of the IP address group.
    ipGroups GetAclRulesRuleIpGroup[]
    The list of domain name groups.
    ipLists string[]
    Single or multiple IP addresses are supported.
    ipLocationCountries string[]
    Country or region code.
    ipLocationSubregions string[]
    Domestic region code.
    name string
    Rule name.
    ruleTag string
    Rule unique identifier, precise search.
    updateTime string
    Update time of the rule.
    url string
    The path of Matching.
    accurate_group GetAclRulesRuleAccurateGroup
    Advanced conditions.
    action str
    Action to be taken on requests that match the rule.
    advanced int
    Whether to set advanced conditions.
    client_ip str
    IP address.
    description str
    Rule description.
    enable int
    The enabled status of the rule.
    host_add_type int
    Type of domain name addition.
    host_group_ids Sequence[int]
    The ID of host group.
    host_groups Sequence[GetAclRulesRuleHostGroup]
    The list of domain name groups.
    host_lists Sequence[str]
    Single or multiple domain names are supported.
    id int
    Rule ID.
    ip_add_type int
    Type of IP address addition.
    ip_group_ids Sequence[int]
    The ID of the IP address group.
    ip_groups Sequence[GetAclRulesRuleIpGroup]
    The list of domain name groups.
    ip_lists Sequence[str]
    Single or multiple IP addresses are supported.
    ip_location_countries Sequence[str]
    Country or region code.
    ip_location_subregions Sequence[str]
    Domestic region code.
    name str
    Rule name.
    rule_tag str
    Rule unique identifier, precise search.
    update_time str
    Update time of the rule.
    url str
    The path of Matching.
    accurateGroup Property Map
    Advanced conditions.
    action String
    Action to be taken on requests that match the rule.
    advanced Number
    Whether to set advanced conditions.
    clientIp String
    IP address.
    description String
    Rule description.
    enable Number
    The enabled status of the rule.
    hostAddType Number
    Type of domain name addition.
    hostGroupIds List<Number>
    The ID of host group.
    hostGroups List<Property Map>
    The list of domain name groups.
    hostLists List<String>
    Single or multiple domain names are supported.
    id Number
    Rule ID.
    ipAddType Number
    Type of IP address addition.
    ipGroupIds List<Number>
    The ID of the IP address group.
    ipGroups List<Property Map>
    The list of domain name groups.
    ipLists List<String>
    Single or multiple IP addresses are supported.
    ipLocationCountries List<String>
    Country or region code.
    ipLocationSubregions List<String>
    Domestic region code.
    name String
    Rule name.
    ruleTag String
    Rule unique identifier, precise search.
    updateTime String
    Update time of the rule.
    url String
    The path of Matching.

    GetAclRulesRuleAccurateGroup

    AccurateRules List<GetAclRulesRuleAccurateGroupAccurateRule>
    Details of advanced conditions.
    Logic int
    The logical relationship of advanced conditions.
    AccurateRules []GetAclRulesRuleAccurateGroupAccurateRule
    Details of advanced conditions.
    Logic int
    The logical relationship of advanced conditions.
    accurateRules List<GetAclRulesRuleAccurateGroupAccurateRule>
    Details of advanced conditions.
    logic Integer
    The logical relationship of advanced conditions.
    accurateRules GetAclRulesRuleAccurateGroupAccurateRule[]
    Details of advanced conditions.
    logic number
    The logical relationship of advanced conditions.
    accurate_rules Sequence[GetAclRulesRuleAccurateGroupAccurateRule]
    Details of advanced conditions.
    logic int
    The logical relationship of advanced conditions.
    accurateRules List<Property Map>
    Details of advanced conditions.
    logic Number
    The logical relationship of advanced conditions.

    GetAclRulesRuleAccurateGroupAccurateRule

    HttpObj string
    The HTTP object to be added to the advanced conditions.
    ObjType int
    The matching field for HTTP objects.
    Opretar int
    The logical operator for the condition.
    Property int
    Operate the properties of the http object.
    ValueString string
    The value to be matched.
    HttpObj string
    The HTTP object to be added to the advanced conditions.
    ObjType int
    The matching field for HTTP objects.
    Opretar int
    The logical operator for the condition.
    Property int
    Operate the properties of the http object.
    ValueString string
    The value to be matched.
    httpObj String
    The HTTP object to be added to the advanced conditions.
    objType Integer
    The matching field for HTTP objects.
    opretar Integer
    The logical operator for the condition.
    property Integer
    Operate the properties of the http object.
    valueString String
    The value to be matched.
    httpObj string
    The HTTP object to be added to the advanced conditions.
    objType number
    The matching field for HTTP objects.
    opretar number
    The logical operator for the condition.
    property number
    Operate the properties of the http object.
    valueString string
    The value to be matched.
    http_obj str
    The HTTP object to be added to the advanced conditions.
    obj_type int
    The matching field for HTTP objects.
    opretar int
    The logical operator for the condition.
    property int
    Operate the properties of the http object.
    value_string str
    The value to be matched.
    httpObj String
    The HTTP object to be added to the advanced conditions.
    objType Number
    The matching field for HTTP objects.
    opretar Number
    The logical operator for the condition.
    property Number
    Operate the properties of the http object.
    valueString String
    The value to be matched.

    GetAclRulesRuleHostGroup

    HostGroupId int
    The ID of host group.
    Name string
    Rule name.
    HostGroupId int
    The ID of host group.
    Name string
    Rule name.
    hostGroupId Integer
    The ID of host group.
    name String
    Rule name.
    hostGroupId number
    The ID of host group.
    name string
    Rule name.
    host_group_id int
    The ID of host group.
    name str
    Rule name.
    hostGroupId Number
    The ID of host group.
    name String
    Rule name.

    GetAclRulesRuleIpGroup

    IpGroupId int
    The ID of the IP address group.
    Name string
    Rule name.
    IpGroupId int
    The ID of the IP address group.
    Name string
    Rule name.
    ipGroupId Integer
    The ID of the IP address group.
    name String
    Rule name.
    ipGroupId number
    The ID of the IP address group.
    name string
    Rule name.
    ip_group_id int
    The ID of the IP address group.
    name str
    Rule name.
    ipGroupId Number
    The ID of the IP address group.
    name String
    Rule name.

    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.34 published on Wednesday, Jul 2, 2025 by Volcengine