1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. getHostGroupRules
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.tls.getHostGroupRules

volcengine logo
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of tls host group rules

    Example Usage

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

const default = volcengine.tls.getHostGroupRules({
    hostGroupId: "4af86d32-cb9c-4eac-adb1-75f2567789be",
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tls.get_host_group_rules(host_group_id="4af86d32-cb9c-4eac-adb1-75f2567789be")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tls.GetHostGroupRules(ctx, &tls.GetHostGroupRulesArgs{
			HostGroupId: "4af86d32-cb9c-4eac-adb1-75f2567789be",
		}, 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 @default = Volcengine.Tls.GetHostGroupRules.Invoke(new()
    {
        HostGroupId = "4af86d32-cb9c-4eac-adb1-75f2567789be",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.TlsFunctions;
import com.pulumi.volcengine.tls.inputs.GetHostGroupRulesArgs;
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 = TlsFunctions.getHostGroupRules(GetHostGroupRulesArgs.builder()
            .hostGroupId("4af86d32-cb9c-4eac-adb1-75f2567789be")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:tls:getHostGroupRules
      Arguments:
        hostGroupId: 4af86d32-cb9c-4eac-adb1-75f2567789be

    Using getHostGroupRules

    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 getHostGroupRules(args: GetHostGroupRulesArgs, opts?: InvokeOptions): Promise<GetHostGroupRulesResult>
function getHostGroupRulesOutput(args: GetHostGroupRulesOutputArgs, opts?: InvokeOptions): Output<GetHostGroupRulesResult>
    def get_host_group_rules(host_group_id: Optional[str] = None,
                         output_file: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetHostGroupRulesResult
def get_host_group_rules_output(host_group_id: Optional[pulumi.Input[str]] = None,
                         output_file: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetHostGroupRulesResult]
    func GetHostGroupRules(ctx *Context, args *GetHostGroupRulesArgs, opts ...InvokeOption) (*GetHostGroupRulesResult, error)
func GetHostGroupRulesOutput(ctx *Context, args *GetHostGroupRulesOutputArgs, opts ...InvokeOption) GetHostGroupRulesResultOutput

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

    public static class GetHostGroupRules 
{
    public static Task<GetHostGroupRulesResult> InvokeAsync(GetHostGroupRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetHostGroupRulesResult> Invoke(GetHostGroupRulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetHostGroupRulesResult> getHostGroupRules(GetHostGroupRulesArgs args, InvokeOptions options)
public static Output<GetHostGroupRulesResult> getHostGroupRules(GetHostGroupRulesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:tls/getHostGroupRules:getHostGroupRules
  arguments:
    # arguments dictionary

    The following arguments are supported:

    HostGroupId string
    The id of host group.
    OutputFile string
    File name where to save data source results.
    HostGroupId string
    The id of host group.
    OutputFile string
    File name where to save data source results.
    hostGroupId String
    The id of host group.
    outputFile String
    File name where to save data source results.
    hostGroupId string
    The id of host group.
    outputFile string
    File name where to save data source results.
    host_group_id str
    The id of host group.
    output_file str
    File name where to save data source results.
    hostGroupId String
    The id of host group.
    outputFile String
    File name where to save data source results.

    getHostGroupRules Result

    The following output properties are available:

    HostGroupId string
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleInfos List<GetHostGroupRulesRuleInfo>
    The collection of rule info.
    TotalCount int
    The total count of query.
    OutputFile string
    HostGroupId string
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleInfos []GetHostGroupRulesRuleInfo
    The collection of rule info.
    TotalCount int
    The total count of query.
    OutputFile string
    hostGroupId String
    id String
    The provider-assigned unique ID for this managed resource.
    ruleInfos List<GetHostGroupRulesRuleInfo>
    The collection of rule info.
    totalCount Integer
    The total count of query.
    outputFile String
    hostGroupId string
    id string
    The provider-assigned unique ID for this managed resource.
    ruleInfos GetHostGroupRulesRuleInfo[]
    The collection of rule info.
    totalCount number
    The total count of query.
    outputFile string
    host_group_id str
    id str
    The provider-assigned unique ID for this managed resource.
    rule_infos Sequence[GetHostGroupRulesRuleInfo]
    The collection of rule info.
    total_count int
    The total count of query.
    output_file str
    hostGroupId String
    id String
    The provider-assigned unique ID for this managed resource.
    ruleInfos List<Property Map>
    The collection of rule info.
    totalCount Number
    The total count of query.
    outputFile String

    Supporting Types

    GetHostGroupRulesRuleInfo

    ContainerRules List<GetHostGroupRulesRuleInfoContainerRule>
    Container collection rules.
    CreateTime string
    The create time of rule.
    ExcludePaths List<GetHostGroupRulesRuleInfoExcludePath>
    Collect the blacklist list.
    ExtractRules List<GetHostGroupRulesRuleInfoExtractRule>
    The extract rule.
    InputType int
    The type of input.
    LogSample string
    The sample of the log.
    LogType string
    The type of log.
    ModifyTime string
    The modify time of rule.
    Paths List<string>
    The paths of rule.
    Pause int
    The pause status of rule.
    RuleId string
    The id of rule.
    RuleName string
    The name of rule.
    TopicId string
    The id of topic.
    TopicName string
    The name of topic.
    UserDefineRules List<GetHostGroupRulesRuleInfoUserDefineRule>
    User-defined collection rules.
    ContainerRules []GetHostGroupRulesRuleInfoContainerRule
    Container collection rules.
    CreateTime string
    The create time of rule.
    ExcludePaths []GetHostGroupRulesRuleInfoExcludePath
    Collect the blacklist list.
    ExtractRules []GetHostGroupRulesRuleInfoExtractRule
    The extract rule.
    InputType int
    The type of input.
    LogSample string
    The sample of the log.
    LogType string
    The type of log.
    ModifyTime string
    The modify time of rule.
    Paths []string
    The paths of rule.
    Pause int
    The pause status of rule.
    RuleId string
    The id of rule.
    RuleName string
    The name of rule.
    TopicId string
    The id of topic.
    TopicName string
    The name of topic.
    UserDefineRules []GetHostGroupRulesRuleInfoUserDefineRule
    User-defined collection rules.
    containerRules List<GetHostGroupRulesRuleInfoContainerRule>
    Container collection rules.
    createTime String
    The create time of rule.
    excludePaths List<GetHostGroupRulesRuleInfoExcludePath>
    Collect the blacklist list.
    extractRules List<GetHostGroupRulesRuleInfoExtractRule>
    The extract rule.
    inputType Integer
    The type of input.
    logSample String
    The sample of the log.
    logType String
    The type of log.
    modifyTime String
    The modify time of rule.
    paths List<String>
    The paths of rule.
    pause Integer
    The pause status of rule.
    ruleId String
    The id of rule.
    ruleName String
    The name of rule.
    topicId String
    The id of topic.
    topicName String
    The name of topic.
    userDefineRules List<GetHostGroupRulesRuleInfoUserDefineRule>
    User-defined collection rules.
    containerRules GetHostGroupRulesRuleInfoContainerRule[]
    Container collection rules.
    createTime string
    The create time of rule.
    excludePaths GetHostGroupRulesRuleInfoExcludePath[]
    Collect the blacklist list.
    extractRules GetHostGroupRulesRuleInfoExtractRule[]
    The extract rule.
    inputType number
    The type of input.
    logSample string
    The sample of the log.
    logType string
    The type of log.
    modifyTime string
    The modify time of rule.
    paths string[]
    The paths of rule.
    pause number
    The pause status of rule.
    ruleId string
    The id of rule.
    ruleName string
    The name of rule.
    topicId string
    The id of topic.
    topicName string
    The name of topic.
    userDefineRules GetHostGroupRulesRuleInfoUserDefineRule[]
    User-defined collection rules.
    container_rules Sequence[GetHostGroupRulesRuleInfoContainerRule]
    Container collection rules.
    create_time str
    The create time of rule.
    exclude_paths Sequence[GetHostGroupRulesRuleInfoExcludePath]
    Collect the blacklist list.
    extract_rules Sequence[GetHostGroupRulesRuleInfoExtractRule]
    The extract rule.
    input_type int
    The type of input.
    log_sample str
    The sample of the log.
    log_type str
    The type of log.
    modify_time str
    The modify time of rule.
    paths Sequence[str]
    The paths of rule.
    pause int
    The pause status of rule.
    rule_id str
    The id of rule.
    rule_name str
    The name of rule.
    topic_id str
    The id of topic.
    topic_name str
    The name of topic.
    user_define_rules Sequence[GetHostGroupRulesRuleInfoUserDefineRule]
    User-defined collection rules.
    containerRules List<Property Map>
    Container collection rules.
    createTime String
    The create time of rule.
    excludePaths List<Property Map>
    Collect the blacklist list.
    extractRules List<Property Map>
    The extract rule.
    inputType Number
    The type of input.
    logSample String
    The sample of the log.
    logType String
    The type of log.
    modifyTime String
    The modify time of rule.
    paths List<String>
    The paths of rule.
    pause Number
    The pause status of rule.
    ruleId String
    The id of rule.
    ruleName String
    The name of rule.
    topicId String
    The id of topic.
    topicName String
    The name of topic.
    userDefineRules List<Property Map>
    User-defined collection rules.

    GetHostGroupRulesRuleInfoContainerRule

    ContainerNameRegex string
    EnvTag Dictionary<string, string>
    ExcludeContainerEnvRegex Dictionary<string, string>
    ExcludeContainerLabelRegex Dictionary<string, string>
    IncludeContainerEnvRegex Dictionary<string, string>
    IncludeContainerLabelRegex Dictionary<string, string>
    KubernetesRules List<GetHostGroupRulesRuleInfoContainerRuleKubernetesRule>
    Stream string
    containerNameRegex string
    envTag {[key: string]: string}
    excludeContainerEnvRegex {[key: string]: string}
    excludeContainerLabelRegex {[key: string]: string}
    includeContainerEnvRegex {[key: string]: string}
    includeContainerLabelRegex {[key: string]: string}
    kubernetesRules GetHostGroupRulesRuleInfoContainerRuleKubernetesRule[]
    stream string

    GetHostGroupRulesRuleInfoContainerRuleKubernetesRule

    AnnotationTag Dictionary<string, string>
    ExcludePodLabelRegex Dictionary<string, string>
    IncludePodLabelRegex Dictionary<string, string>
    LabelTag Dictionary<string, string>
    NamespaceNameRegex string
    PodNameRegex string
    WorkloadNameRegex string
    WorkloadType string
    AnnotationTag map[string]string
    ExcludePodLabelRegex map[string]string
    IncludePodLabelRegex map[string]string
    LabelTag map[string]string
    NamespaceNameRegex string
    PodNameRegex string
    WorkloadNameRegex string
    WorkloadType string
    annotationTag Map<String,String>
    excludePodLabelRegex Map<String,String>
    includePodLabelRegex Map<String,String>
    labelTag Map<String,String>
    namespaceNameRegex String
    podNameRegex String
    workloadNameRegex String
    workloadType String
    annotationTag {[key: string]: string}
    excludePodLabelRegex {[key: string]: string}
    includePodLabelRegex {[key: string]: string}
    labelTag {[key: string]: string}
    namespaceNameRegex string
    podNameRegex string
    workloadNameRegex string
    workloadType string

    GetHostGroupRulesRuleInfoExcludePath

    Type string
    Value string
    Type string
    Value string
    type String
    value String
    type string
    value string
    type str
    value str
    type String
    value String

    GetHostGroupRulesRuleInfoExtractRule

    GetHostGroupRulesRuleInfoExtractRuleFilterKeyRegex

    Key string
    Regex string
    Key string
    Regex string
    key String
    regex String
    key string
    regex string
    key str
    regex str
    key String
    regex String

    GetHostGroupRulesRuleInfoExtractRuleLogTemplate

    Format string
    Type string
    Format string
    Type string
    format String
    type String
    format string
    type string
    format str
    type str
    format String
    type String

    GetHostGroupRulesRuleInfoUserDefineRule

    GetHostGroupRulesRuleInfoUserDefineRuleAdvanced

    closeEof Boolean
    closeInactive Integer
    closeRemoved Boolean
    closeRenamed Boolean
    closeTimeout Integer
    closeEof boolean
    closeInactive number
    closeRemoved boolean
    closeRenamed boolean
    closeTimeout number
    closeEof Boolean
    closeInactive Number
    closeRemoved Boolean
    closeRenamed Boolean
    closeTimeout Number

    GetHostGroupRulesRuleInfoUserDefineRuleParsePathRule

    Keys List<string>
    PathSample string
    Regex string
    Keys []string
    PathSample string
    Regex string
    keys List<String>
    pathSample String
    regex String
    keys string[]
    pathSample string
    regex string
    keys Sequence[str]
    path_sample str
    regex str
    keys List<String>
    pathSample String
    regex String

    GetHostGroupRulesRuleInfoUserDefineRulePlugin

    Processors List<string>
    Processors []string
    processors List<String>
    processors string[]
    processors Sequence[str]
    processors List<String>

    GetHostGroupRulesRuleInfoUserDefineRuleShardHashKey

    HashKey string
    HashKey string
    hashKey String
    hashKey string
    hashKey String

    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.45 published on Tuesday, Feb 10, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate