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

volcengine.waf.getHostGroups

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 host groups

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    
    const foo = volcengine.waf.getHostGroups({
        hostFix: "www.tf-test.com",
        timeOrderBy: "DESC",
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.waf.get_host_groups(host_fix="www.tf-test.com",
        time_order_by="DESC")
    
    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.GetHostGroups(ctx, &waf.GetHostGroupsArgs{
    			HostFix:     pulumi.StringRef("www.tf-test.com"),
    			TimeOrderBy: "DESC",
    		}, 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.GetHostGroups.Invoke(new()
        {
            HostFix = "www.tf-test.com",
            TimeOrderBy = "DESC",
        });
    
    });
    
    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.GetHostGroupsArgs;
    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.getHostGroups(GetHostGroupsArgs.builder()
                .hostFix("www.tf-test.com")
                .timeOrderBy("DESC")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: volcengine:waf:getHostGroups
          Arguments:
            hostFix: www.tf-test.com
            timeOrderBy: DESC
    

    Using getHostGroups

    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 getHostGroups(args: GetHostGroupsArgs, opts?: InvokeOptions): Promise<GetHostGroupsResult>
    function getHostGroupsOutput(args: GetHostGroupsOutputArgs, opts?: InvokeOptions): Output<GetHostGroupsResult>
    def get_host_groups(host_fix: Optional[str] = None,
                        host_group_id: Optional[int] = None,
                        ids: Optional[Sequence[str]] = None,
                        list_all: Optional[bool] = None,
                        name_fix: Optional[str] = None,
                        name_regex: Optional[str] = None,
                        output_file: Optional[str] = None,
                        rule_tag: Optional[str] = None,
                        time_order_by: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetHostGroupsResult
    def get_host_groups_output(host_fix: Optional[pulumi.Input[str]] = None,
                        host_group_id: Optional[pulumi.Input[int]] = None,
                        ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        list_all: Optional[pulumi.Input[bool]] = None,
                        name_fix: Optional[pulumi.Input[str]] = None,
                        name_regex: Optional[pulumi.Input[str]] = None,
                        output_file: 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[GetHostGroupsResult]
    func GetHostGroups(ctx *Context, args *GetHostGroupsArgs, opts ...InvokeOption) (*GetHostGroupsResult, error)
    func GetHostGroupsOutput(ctx *Context, args *GetHostGroupsOutputArgs, opts ...InvokeOption) GetHostGroupsResultOutput

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

    public static class GetHostGroups 
    {
        public static Task<GetHostGroupsResult> InvokeAsync(GetHostGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetHostGroupsResult> Invoke(GetHostGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHostGroupsResult> getHostGroups(GetHostGroupsArgs args, InvokeOptions options)
    public static Output<GetHostGroupsResult> getHostGroups(GetHostGroupsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:waf/getHostGroups:getHostGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    TimeOrderBy string
    The list of rule ids associated with the domain name group shows the timing sequence.
    HostFix string
    The domain name information queried.
    HostGroupId int
    The ID of the domain name group.
    Ids List<string>
    A list of IDs.
    ListAll bool
    Whether to return all domain name groups and their name information, it returns by default.
    NameFix string
    The name of the domain name group being queried.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    RuleTag string
    The rule ID associated with domain name groups.
    TimeOrderBy string
    The list of rule ids associated with the domain name group shows the timing sequence.
    HostFix string
    The domain name information queried.
    HostGroupId int
    The ID of the domain name group.
    Ids []string
    A list of IDs.
    ListAll bool
    Whether to return all domain name groups and their name information, it returns by default.
    NameFix string
    The name of the domain name group being queried.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    RuleTag string
    The rule ID associated with domain name groups.
    timeOrderBy String
    The list of rule ids associated with the domain name group shows the timing sequence.
    hostFix String
    The domain name information queried.
    hostGroupId Integer
    The ID of the domain name group.
    ids List<String>
    A list of IDs.
    listAll Boolean
    Whether to return all domain name groups and their name information, it returns by default.
    nameFix String
    The name of the domain name group being queried.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    ruleTag String
    The rule ID associated with domain name groups.
    timeOrderBy string
    The list of rule ids associated with the domain name group shows the timing sequence.
    hostFix string
    The domain name information queried.
    hostGroupId number
    The ID of the domain name group.
    ids string[]
    A list of IDs.
    listAll boolean
    Whether to return all domain name groups and their name information, it returns by default.
    nameFix string
    The name of the domain name group being queried.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    ruleTag string
    The rule ID associated with domain name groups.
    time_order_by str
    The list of rule ids associated with the domain name group shows the timing sequence.
    host_fix str
    The domain name information queried.
    host_group_id int
    The ID of the domain name group.
    ids Sequence[str]
    A list of IDs.
    list_all bool
    Whether to return all domain name groups and their name information, it returns by default.
    name_fix str
    The name of the domain name group being queried.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    rule_tag str
    The rule ID associated with domain name groups.
    timeOrderBy String
    The list of rule ids associated with the domain name group shows the timing sequence.
    hostFix String
    The domain name information queried.
    hostGroupId Number
    The ID of the domain name group.
    ids List<String>
    A list of IDs.
    listAll Boolean
    Whether to return all domain name groups and their name information, it returns by default.
    nameFix String
    The name of the domain name group being queried.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    ruleTag String
    The rule ID associated with domain name groups.

    getHostGroups Result

    The following output properties are available:

    HostGroupLists List<GetHostGroupsHostGroupList>
    Details of the domain name group list.
    Id string
    The provider-assigned unique ID for this managed resource.
    TimeOrderBy string
    TotalCount int
    The total count of query.
    HostFix string
    HostGroupId int
    The ID of the domain name group.
    Ids List<string>
    ListAll bool
    NameFix string
    NameRegex string
    OutputFile string
    RuleTag string
    The ID of the rule.
    HostGroupLists []GetHostGroupsHostGroupList
    Details of the domain name group list.
    Id string
    The provider-assigned unique ID for this managed resource.
    TimeOrderBy string
    TotalCount int
    The total count of query.
    HostFix string
    HostGroupId int
    The ID of the domain name group.
    Ids []string
    ListAll bool
    NameFix string
    NameRegex string
    OutputFile string
    RuleTag string
    The ID of the rule.
    hostGroupLists List<GetHostGroupsHostGroupList>
    Details of the domain name group list.
    id String
    The provider-assigned unique ID for this managed resource.
    timeOrderBy String
    totalCount Integer
    The total count of query.
    hostFix String
    hostGroupId Integer
    The ID of the domain name group.
    ids List<String>
    listAll Boolean
    nameFix String
    nameRegex String
    outputFile String
    ruleTag String
    The ID of the rule.
    hostGroupLists GetHostGroupsHostGroupList[]
    Details of the domain name group list.
    id string
    The provider-assigned unique ID for this managed resource.
    timeOrderBy string
    totalCount number
    The total count of query.
    hostFix string
    hostGroupId number
    The ID of the domain name group.
    ids string[]
    listAll boolean
    nameFix string
    nameRegex string
    outputFile string
    ruleTag string
    The ID of the rule.
    host_group_lists Sequence[GetHostGroupsHostGroupList]
    Details of the domain name group list.
    id str
    The provider-assigned unique ID for this managed resource.
    time_order_by str
    total_count int
    The total count of query.
    host_fix str
    host_group_id int
    The ID of the domain name group.
    ids Sequence[str]
    list_all bool
    name_fix str
    name_regex str
    output_file str
    rule_tag str
    The ID of the rule.
    hostGroupLists List<Property Map>
    Details of the domain name group list.
    id String
    The provider-assigned unique ID for this managed resource.
    timeOrderBy String
    totalCount Number
    The total count of query.
    hostFix String
    hostGroupId Number
    The ID of the domain name group.
    ids List<String>
    listAll Boolean
    nameFix String
    nameRegex String
    outputFile String
    ruleTag String
    The ID of the rule.

    Supporting Types

    GetHostGroupsHostGroupList

    Description string
    Domain name group description.
    HostCount int
    The number of domain names contained in the domain name group.
    HostGroupId int
    The ID of the domain name group.
    HostLists List<string>
    Domain names that need to be added to this domain name group.
    Name string
    The name of the domain name group.
    RelatedRules List<GetHostGroupsHostGroupListRelatedRule>
    The list of associated rules.
    UpdateTime string
    Domain name group update time.
    Description string
    Domain name group description.
    HostCount int
    The number of domain names contained in the domain name group.
    HostGroupId int
    The ID of the domain name group.
    HostLists []string
    Domain names that need to be added to this domain name group.
    Name string
    The name of the domain name group.
    RelatedRules []GetHostGroupsHostGroupListRelatedRule
    The list of associated rules.
    UpdateTime string
    Domain name group update time.
    description String
    Domain name group description.
    hostCount Integer
    The number of domain names contained in the domain name group.
    hostGroupId Integer
    The ID of the domain name group.
    hostLists List<String>
    Domain names that need to be added to this domain name group.
    name String
    The name of the domain name group.
    relatedRules List<GetHostGroupsHostGroupListRelatedRule>
    The list of associated rules.
    updateTime String
    Domain name group update time.
    description string
    Domain name group description.
    hostCount number
    The number of domain names contained in the domain name group.
    hostGroupId number
    The ID of the domain name group.
    hostLists string[]
    Domain names that need to be added to this domain name group.
    name string
    The name of the domain name group.
    relatedRules GetHostGroupsHostGroupListRelatedRule[]
    The list of associated rules.
    updateTime string
    Domain name group update time.
    description str
    Domain name group description.
    host_count int
    The number of domain names contained in the domain name group.
    host_group_id int
    The ID of the domain name group.
    host_lists Sequence[str]
    Domain names that need to be added to this domain name group.
    name str
    The name of the domain name group.
    related_rules Sequence[GetHostGroupsHostGroupListRelatedRule]
    The list of associated rules.
    update_time str
    Domain name group update time.
    description String
    Domain name group description.
    hostCount Number
    The number of domain names contained in the domain name group.
    hostGroupId Number
    The ID of the domain name group.
    hostLists List<String>
    Domain names that need to be added to this domain name group.
    name String
    The name of the domain name group.
    relatedRules List<Property Map>
    The list of associated rules.
    updateTime String
    Domain name group update time.

    GetHostGroupsHostGroupListRelatedRule

    RuleName string
    The name of the rule.
    RuleTag string
    The rule ID associated with domain name groups.
    RuleType string
    The type of the rule.
    RuleName string
    The name of the rule.
    RuleTag string
    The rule ID associated with domain name groups.
    RuleType string
    The type of the rule.
    ruleName String
    The name of the rule.
    ruleTag String
    The rule ID associated with domain name groups.
    ruleType String
    The type of the rule.
    ruleName string
    The name of the rule.
    ruleTag string
    The rule ID associated with domain name groups.
    ruleType string
    The type of the rule.
    rule_name str
    The name of the rule.
    rule_tag str
    The rule ID associated with domain name groups.
    rule_type str
    The type of the rule.
    ruleName String
    The name of the rule.
    ruleTag String
    The rule ID associated with domain name groups.
    ruleType String
    The type of the rule.

    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