1. Packages
  2. Volcengine
  3. API Docs
  4. alb
  5. getRules
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.alb.getRules

volcengine logo
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of alb rules

    Example Usage

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

const foo = volcengine.alb.getRules({
    listenerId: "lsn-1iidd19u4oni874adhezjkyj3",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.alb.get_rules(listener_id="lsn-1iidd19u4oni874adhezjkyj3")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := alb.GetRules(ctx, &alb.GetRulesArgs{
			ListenerId: "lsn-1iidd19u4oni874adhezjkyj3",
		}, 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.Alb.GetRules.Invoke(new()
    {
        ListenerId = "lsn-1iidd19u4oni874adhezjkyj3",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.alb.AlbFunctions;
import com.pulumi.volcengine.alb.inputs.GetRulesArgs;
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 = AlbFunctions.getRules(GetRulesArgs.builder()
            .listenerId("lsn-1iidd19u4oni874adhezjkyj3")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:alb:getRules
      Arguments:
        listenerId: lsn-1iidd19u4oni874adhezjkyj3

    Using getRules

    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 getRules(args: GetRulesArgs, opts?: InvokeOptions): Promise<GetRulesResult>
function getRulesOutput(args: GetRulesOutputArgs, opts?: InvokeOptions): Output<GetRulesResult>
    def get_rules(listener_id: Optional[str] = None,
              output_file: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetRulesResult
def get_rules_output(listener_id: Optional[pulumi.Input[str]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRulesResult]
    func GetRules(ctx *Context, args *GetRulesArgs, opts ...InvokeOption) (*GetRulesResult, error)
func GetRulesOutput(ctx *Context, args *GetRulesOutputArgs, opts ...InvokeOption) GetRulesResultOutput

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

    public static class GetRules 
{
    public static Task<GetRulesResult> InvokeAsync(GetRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetRulesResult> Invoke(GetRulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRulesResult> getRules(GetRulesArgs args, InvokeOptions options)
public static Output<GetRulesResult> getRules(GetRulesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:alb/getRules:getRules
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ListenerId string
    The Id of listener.
    OutputFile string
    File name where to save data source results.
    ListenerId string
    The Id of listener.
    OutputFile string
    File name where to save data source results.
    listenerId String
    The Id of listener.
    outputFile String
    File name where to save data source results.
    listenerId string
    The Id of listener.
    outputFile string
    File name where to save data source results.
    listener_id str
    The Id of listener.
    output_file str
    File name where to save data source results.
    listenerId String
    The Id of listener.
    outputFile String
    File name where to save data source results.

    getRules Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    Rules List<GetRulesRule>
    The collection of Rule query.
    TotalCount int
    The total count of Rule query.
    OutputFile string
    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    Rules []GetRulesRule
    The collection of Rule query.
    TotalCount int
    The total count of Rule query.
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    rules List<GetRulesRule>
    The collection of Rule query.
    totalCount Integer
    The total count of Rule query.
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    listenerId string
    rules GetRulesRule[]
    The collection of Rule query.
    totalCount number
    The total count of Rule query.
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    listener_id str
    rules Sequence[GetRulesRule]
    The collection of Rule query.
    total_count int
    The total count of Rule query.
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    rules List<Property Map>
    The collection of Rule query.
    totalCount Number
    The total count of Rule query.
    outputFile String

    Supporting Types

    GetRulesRule

    Description string
    The Description of Rule.
    Domain string
    The Domain of Rule.
    ForwardGroupConfigs List<GetRulesRuleForwardGroupConfig>
    Forward group configuration for ForwardGroup type action.
    Id string
    The Id of Rule.
    Priority int
    The priority of the Rule. Only the standard version is supported.
    RedirectConfigs List<GetRulesRuleRedirectConfig>
    Redirect configuration for Redirect type action.
    RewriteConfigs List<GetRulesRuleRewriteConfig>
    Rewrite configuration for Rewrite type action.
    RewriteEnabled string
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    RuleAction string
    The forwarding rule action, if this parameter is empty, forward to server group, if value is Redirect, will redirect.
    RuleActions List<GetRulesRuleRuleAction>
    The rule actions for standard edition forwarding rules.
    RuleConditions List<GetRulesRuleRuleCondition>
    The rule conditions for standard edition forwarding rules.
    RuleId string
    The Id of Rule.
    ServerGroupId string
    The Id of Server Group.
    TrafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    TrafficLimitQps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    Url string
    The Url of Rule.
    Description string
    The Description of Rule.
    Domain string
    The Domain of Rule.
    ForwardGroupConfigs []GetRulesRuleForwardGroupConfig
    Forward group configuration for ForwardGroup type action.
    Id string
    The Id of Rule.
    Priority int
    The priority of the Rule. Only the standard version is supported.
    RedirectConfigs []GetRulesRuleRedirectConfig
    Redirect configuration for Redirect type action.
    RewriteConfigs []GetRulesRuleRewriteConfig
    Rewrite configuration for Rewrite type action.
    RewriteEnabled string
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    RuleAction string
    The forwarding rule action, if this parameter is empty, forward to server group, if value is Redirect, will redirect.
    RuleActions []GetRulesRuleRuleAction
    The rule actions for standard edition forwarding rules.
    RuleConditions []GetRulesRuleRuleCondition
    The rule conditions for standard edition forwarding rules.
    RuleId string
    The Id of Rule.
    ServerGroupId string
    The Id of Server Group.
    TrafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    TrafficLimitQps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    Url string
    The Url of Rule.
    description String
    The Description of Rule.
    domain String
    The Domain of Rule.
    forwardGroupConfigs List<GetRulesRuleForwardGroupConfig>
    Forward group configuration for ForwardGroup type action.
    id String
    The Id of Rule.
    priority Integer
    The priority of the Rule. Only the standard version is supported.
    redirectConfigs List<GetRulesRuleRedirectConfig>
    Redirect configuration for Redirect type action.
    rewriteConfigs List<GetRulesRuleRewriteConfig>
    Rewrite configuration for Rewrite type action.
    rewriteEnabled String
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    ruleAction String
    The forwarding rule action, if this parameter is empty, forward to server group, if value is Redirect, will redirect.
    ruleActions List<GetRulesRuleRuleAction>
    The rule actions for standard edition forwarding rules.
    ruleConditions List<GetRulesRuleRuleCondition>
    The rule conditions for standard edition forwarding rules.
    ruleId String
    The Id of Rule.
    serverGroupId String
    The Id of Server Group.
    trafficLimitEnabled String
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps Integer
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url String
    The Url of Rule.
    description string
    The Description of Rule.
    domain string
    The Domain of Rule.
    forwardGroupConfigs GetRulesRuleForwardGroupConfig[]
    Forward group configuration for ForwardGroup type action.
    id string
    The Id of Rule.
    priority number
    The priority of the Rule. Only the standard version is supported.
    redirectConfigs GetRulesRuleRedirectConfig[]
    Redirect configuration for Redirect type action.
    rewriteConfigs GetRulesRuleRewriteConfig[]
    Rewrite configuration for Rewrite type action.
    rewriteEnabled string
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    ruleAction string
    The forwarding rule action, if this parameter is empty, forward to server group, if value is Redirect, will redirect.
    ruleActions GetRulesRuleRuleAction[]
    The rule actions for standard edition forwarding rules.
    ruleConditions GetRulesRuleRuleCondition[]
    The rule conditions for standard edition forwarding rules.
    ruleId string
    The Id of Rule.
    serverGroupId string
    The Id of Server Group.
    trafficLimitEnabled string
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps number
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url string
    The Url of Rule.
    description str
    The Description of Rule.
    domain str
    The Domain of Rule.
    forward_group_configs Sequence[GetRulesRuleForwardGroupConfig]
    Forward group configuration for ForwardGroup type action.
    id str
    The Id of Rule.
    priority int
    The priority of the Rule. Only the standard version is supported.
    redirect_configs Sequence[GetRulesRuleRedirectConfig]
    Redirect configuration for Redirect type action.
    rewrite_configs Sequence[GetRulesRuleRewriteConfig]
    Rewrite configuration for Rewrite type action.
    rewrite_enabled str
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    rule_action str
    The forwarding rule action, if this parameter is empty, forward to server group, if value is Redirect, will redirect.
    rule_actions Sequence[GetRulesRuleRuleAction]
    The rule actions for standard edition forwarding rules.
    rule_conditions Sequence[GetRulesRuleRuleCondition]
    The rule conditions for standard edition forwarding rules.
    rule_id str
    The Id of Rule.
    server_group_id str
    The Id of Server Group.
    traffic_limit_enabled str
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    traffic_limit_qps int
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url str
    The Url of Rule.
    description String
    The Description of Rule.
    domain String
    The Domain of Rule.
    forwardGroupConfigs List<Property Map>
    Forward group configuration for ForwardGroup type action.
    id String
    The Id of Rule.
    priority Number
    The priority of the Rule. Only the standard version is supported.
    redirectConfigs List<Property Map>
    Redirect configuration for Redirect type action.
    rewriteConfigs List<Property Map>
    Rewrite configuration for Rewrite type action.
    rewriteEnabled String
    Rewrite configuration switch for forwarding rules, only allows configuration and takes effect when RuleAction is empty (i.e., forwarding to server group). Only available for whitelist users, please submit an application to experience. Supported values are as follows: on: enable. off: disable.
    ruleAction String
    The forwarding rule action, if this parameter is empty, forward to server group, if value is Redirect, will redirect.
    ruleActions List<Property Map>
    The rule actions for standard edition forwarding rules.
    ruleConditions List<Property Map>
    The rule conditions for standard edition forwarding rules.
    ruleId String
    The Id of Rule.
    serverGroupId String
    The Id of Server Group.
    trafficLimitEnabled String
    Forwarding rule QPS rate limiting switch: on: enable. off: disable (default).
    trafficLimitQps Number
    When Rules.N.TrafficLimitEnabled is turned on, this field is required. Requests per second. Valid values are between 100 and 100000.
    url String
    The Url of Rule.

    GetRulesRuleForwardGroupConfig

    ServerGroupTuples List<GetRulesRuleForwardGroupConfigServerGroupTuple>
    The server group tuples.
    StickySessionEnabled string
    Whether to enable inter-group session hold.
    StickySessionTimeout int
    The group session stickiness timeout, in seconds.
    ServerGroupTuples []GetRulesRuleForwardGroupConfigServerGroupTuple
    The server group tuples.
    StickySessionEnabled string
    Whether to enable inter-group session hold.
    StickySessionTimeout int
    The group session stickiness timeout, in seconds.
    serverGroupTuples List<GetRulesRuleForwardGroupConfigServerGroupTuple>
    The server group tuples.
    stickySessionEnabled String
    Whether to enable inter-group session hold.
    stickySessionTimeout Integer
    The group session stickiness timeout, in seconds.
    serverGroupTuples GetRulesRuleForwardGroupConfigServerGroupTuple[]
    The server group tuples.
    stickySessionEnabled string
    Whether to enable inter-group session hold.
    stickySessionTimeout number
    The group session stickiness timeout, in seconds.
    server_group_tuples Sequence[GetRulesRuleForwardGroupConfigServerGroupTuple]
    The server group tuples.
    sticky_session_enabled str
    Whether to enable inter-group session hold.
    sticky_session_timeout int
    The group session stickiness timeout, in seconds.
    serverGroupTuples List<Property Map>
    The server group tuples.
    stickySessionEnabled String
    Whether to enable inter-group session hold.
    stickySessionTimeout Number
    The group session stickiness timeout, in seconds.

    GetRulesRuleForwardGroupConfigServerGroupTuple

    ServerGroupId string
    The Id of Server Group.
    Weight string
    The weight of the server group.
    ServerGroupId string
    The Id of Server Group.
    Weight string
    The weight of the server group.
    serverGroupId String
    The Id of Server Group.
    weight String
    The weight of the server group.
    serverGroupId string
    The Id of Server Group.
    weight string
    The weight of the server group.
    server_group_id str
    The Id of Server Group.
    weight str
    The weight of the server group.
    serverGroupId String
    The Id of Server Group.
    weight String
    The weight of the server group.

    GetRulesRuleRedirectConfig

    RedirectDomain string
    The redirect domain.
    RedirectHttpCode string
    The redirect HTTP code.
    RedirectPort string
    The redirect port.
    RedirectProtocol string
    The redirect protocol.
    RedirectUri string
    The redirect URI.
    RedirectDomain string
    The redirect domain.
    RedirectHttpCode string
    The redirect HTTP code.
    RedirectPort string
    The redirect port.
    RedirectProtocol string
    The redirect protocol.
    RedirectUri string
    The redirect URI.
    redirectDomain String
    The redirect domain.
    redirectHttpCode String
    The redirect HTTP code.
    redirectPort String
    The redirect port.
    redirectProtocol String
    The redirect protocol.
    redirectUri String
    The redirect URI.
    redirectDomain string
    The redirect domain.
    redirectHttpCode string
    The redirect HTTP code.
    redirectPort string
    The redirect port.
    redirectProtocol string
    The redirect protocol.
    redirectUri string
    The redirect URI.
    redirect_domain str
    The redirect domain.
    redirect_http_code str
    The redirect HTTP code.
    redirect_port str
    The redirect port.
    redirect_protocol str
    The redirect protocol.
    redirect_uri str
    The redirect URI.
    redirectDomain String
    The redirect domain.
    redirectHttpCode String
    The redirect HTTP code.
    redirectPort String
    The redirect port.
    redirectProtocol String
    The redirect protocol.
    redirectUri String
    The redirect URI.

    GetRulesRuleRewriteConfig

    RewritePath string
    Rewrite path.
    RewritePath string
    Rewrite path.
    rewritePath String
    Rewrite path.
    rewritePath string
    Rewrite path.
    rewrite_path str
    Rewrite path.
    rewritePath String
    Rewrite path.

    GetRulesRuleRuleAction

    FixedResponseConfigs List<GetRulesRuleRuleActionFixedResponseConfig>
    Fixed response configuration for fixed response type rule.
    ForwardGroupConfigs List<GetRulesRuleRuleActionForwardGroupConfig>
    Forward group configuration for ForwardGroup type action.
    RedirectConfigs List<GetRulesRuleRuleActionRedirectConfig>
    Redirect configuration for Redirect type action.
    RewriteConfigs List<GetRulesRuleRuleActionRewriteConfig>
    Rewrite configuration for Rewrite type action.
    TrafficLimitConfigs List<GetRulesRuleRuleActionTrafficLimitConfig>
    Traffic limit configuration for TrafficLimit type action.
    Type string
    The type of rule condition. Valid values: Host, Path, Header.
    FixedResponseConfigs []GetRulesRuleRuleActionFixedResponseConfig
    Fixed response configuration for fixed response type rule.
    ForwardGroupConfigs []GetRulesRuleRuleActionForwardGroupConfig
    Forward group configuration for ForwardGroup type action.
    RedirectConfigs []GetRulesRuleRuleActionRedirectConfig
    Redirect configuration for Redirect type action.
    RewriteConfigs []GetRulesRuleRuleActionRewriteConfig
    Rewrite configuration for Rewrite type action.
    TrafficLimitConfigs []GetRulesRuleRuleActionTrafficLimitConfig
    Traffic limit configuration for TrafficLimit type action.
    Type string
    The type of rule condition. Valid values: Host, Path, Header.
    fixedResponseConfigs List<GetRulesRuleRuleActionFixedResponseConfig>
    Fixed response configuration for fixed response type rule.
    forwardGroupConfigs List<GetRulesRuleRuleActionForwardGroupConfig>
    Forward group configuration for ForwardGroup type action.
    redirectConfigs List<GetRulesRuleRuleActionRedirectConfig>
    Redirect configuration for Redirect type action.
    rewriteConfigs List<GetRulesRuleRuleActionRewriteConfig>
    Rewrite configuration for Rewrite type action.
    trafficLimitConfigs List<GetRulesRuleRuleActionTrafficLimitConfig>
    Traffic limit configuration for TrafficLimit type action.
    type String
    The type of rule condition. Valid values: Host, Path, Header.
    fixedResponseConfigs GetRulesRuleRuleActionFixedResponseConfig[]
    Fixed response configuration for fixed response type rule.
    forwardGroupConfigs GetRulesRuleRuleActionForwardGroupConfig[]
    Forward group configuration for ForwardGroup type action.
    redirectConfigs GetRulesRuleRuleActionRedirectConfig[]
    Redirect configuration for Redirect type action.
    rewriteConfigs GetRulesRuleRuleActionRewriteConfig[]
    Rewrite configuration for Rewrite type action.
    trafficLimitConfigs GetRulesRuleRuleActionTrafficLimitConfig[]
    Traffic limit configuration for TrafficLimit type action.
    type string
    The type of rule condition. Valid values: Host, Path, Header.
    fixed_response_configs Sequence[GetRulesRuleRuleActionFixedResponseConfig]
    Fixed response configuration for fixed response type rule.
    forward_group_configs Sequence[GetRulesRuleRuleActionForwardGroupConfig]
    Forward group configuration for ForwardGroup type action.
    redirect_configs Sequence[GetRulesRuleRuleActionRedirectConfig]
    Redirect configuration for Redirect type action.
    rewrite_configs Sequence[GetRulesRuleRuleActionRewriteConfig]
    Rewrite configuration for Rewrite type action.
    traffic_limit_configs Sequence[GetRulesRuleRuleActionTrafficLimitConfig]
    Traffic limit configuration for TrafficLimit type action.
    type str
    The type of rule condition. Valid values: Host, Path, Header.
    fixedResponseConfigs List<Property Map>
    Fixed response configuration for fixed response type rule.
    forwardGroupConfigs List<Property Map>
    Forward group configuration for ForwardGroup type action.
    redirectConfigs List<Property Map>
    Redirect configuration for Redirect type action.
    rewriteConfigs List<Property Map>
    Rewrite configuration for Rewrite type action.
    trafficLimitConfigs List<Property Map>
    Traffic limit configuration for TrafficLimit type action.
    type String
    The type of rule condition. Valid values: Host, Path, Header.

    GetRulesRuleRuleActionFixedResponseConfig

    ContentType string
    The content type of the fixed response.
    ResponseBody string
    The response body of the fixed response.
    ResponseCode string
    The fixed response HTTP status code.
    ResponseMessage string
    The fixed response message.
    ContentType string
    The content type of the fixed response.
    ResponseBody string
    The response body of the fixed response.
    ResponseCode string
    The fixed response HTTP status code.
    ResponseMessage string
    The fixed response message.
    contentType String
    The content type of the fixed response.
    responseBody String
    The response body of the fixed response.
    responseCode String
    The fixed response HTTP status code.
    responseMessage String
    The fixed response message.
    contentType string
    The content type of the fixed response.
    responseBody string
    The response body of the fixed response.
    responseCode string
    The fixed response HTTP status code.
    responseMessage string
    The fixed response message.
    content_type str
    The content type of the fixed response.
    response_body str
    The response body of the fixed response.
    response_code str
    The fixed response HTTP status code.
    response_message str
    The fixed response message.
    contentType String
    The content type of the fixed response.
    responseBody String
    The response body of the fixed response.
    responseCode String
    The fixed response HTTP status code.
    responseMessage String
    The fixed response message.

    GetRulesRuleRuleActionForwardGroupConfig

    serverGroupStickySessions List<Property Map>
    The config of group session stickiness.
    serverGroupTuples List<Property Map>
    The server group tuples.

    GetRulesRuleRuleActionForwardGroupConfigServerGroupStickySession

    Enabled string
    Whether to enable sticky session stickiness. Valid values are 'on' and 'off'.
    Timeout int
    The sticky session timeout, in seconds.
    Enabled string
    Whether to enable sticky session stickiness. Valid values are 'on' and 'off'.
    Timeout int
    The sticky session timeout, in seconds.
    enabled String
    Whether to enable sticky session stickiness. Valid values are 'on' and 'off'.
    timeout Integer
    The sticky session timeout, in seconds.
    enabled string
    Whether to enable sticky session stickiness. Valid values are 'on' and 'off'.
    timeout number
    The sticky session timeout, in seconds.
    enabled str
    Whether to enable sticky session stickiness. Valid values are 'on' and 'off'.
    timeout int
    The sticky session timeout, in seconds.
    enabled String
    Whether to enable sticky session stickiness. Valid values are 'on' and 'off'.
    timeout Number
    The sticky session timeout, in seconds.

    GetRulesRuleRuleActionForwardGroupConfigServerGroupTuple

    ServerGroupId string
    The Id of Server Group.
    Weight int
    The weight of the server group.
    ServerGroupId string
    The Id of Server Group.
    Weight int
    The weight of the server group.
    serverGroupId String
    The Id of Server Group.
    weight Integer
    The weight of the server group.
    serverGroupId string
    The Id of Server Group.
    weight number
    The weight of the server group.
    server_group_id str
    The Id of Server Group.
    weight int
    The weight of the server group.
    serverGroupId String
    The Id of Server Group.
    weight Number
    The weight of the server group.

    GetRulesRuleRuleActionRedirectConfig

    RedirectDomain string
    The redirect domain.
    RedirectHttpCode string
    The redirect HTTP code.
    RedirectPort string
    The redirect port.
    RedirectProtocol string
    The redirect protocol.
    RedirectUri string
    The redirect URI.
    RedirectDomain string
    The redirect domain.
    RedirectHttpCode string
    The redirect HTTP code.
    RedirectPort string
    The redirect port.
    RedirectProtocol string
    The redirect protocol.
    RedirectUri string
    The redirect URI.
    redirectDomain String
    The redirect domain.
    redirectHttpCode String
    The redirect HTTP code.
    redirectPort String
    The redirect port.
    redirectProtocol String
    The redirect protocol.
    redirectUri String
    The redirect URI.
    redirectDomain string
    The redirect domain.
    redirectHttpCode string
    The redirect HTTP code.
    redirectPort string
    The redirect port.
    redirectProtocol string
    The redirect protocol.
    redirectUri string
    The redirect URI.
    redirect_domain str
    The redirect domain.
    redirect_http_code str
    The redirect HTTP code.
    redirect_port str
    The redirect port.
    redirect_protocol str
    The redirect protocol.
    redirect_uri str
    The redirect URI.
    redirectDomain String
    The redirect domain.
    redirectHttpCode String
    The redirect HTTP code.
    redirectPort String
    The redirect port.
    redirectProtocol String
    The redirect protocol.
    redirectUri String
    The redirect URI.

    GetRulesRuleRuleActionRewriteConfig

    Path string
    The rewrite path.
    Path string
    The rewrite path.
    path String
    The rewrite path.
    path string
    The rewrite path.
    path str
    The rewrite path.
    path String
    The rewrite path.

    GetRulesRuleRuleActionTrafficLimitConfig

    Qps int
    The QPS limit.
    Qps int
    The QPS limit.
    qps Integer
    The QPS limit.
    qps number
    The QPS limit.
    qps int
    The QPS limit.
    qps Number
    The QPS limit.

    GetRulesRuleRuleCondition

    HeaderConfigs List<GetRulesRuleRuleConditionHeaderConfig>
    Header configuration for Header type condition.
    HostConfigs List<GetRulesRuleRuleConditionHostConfig>
    Host configuration for host type condition.
    MethodConfigs List<GetRulesRuleRuleConditionMethodConfig>
    Method configuration for Method type condition.
    PathConfigs List<GetRulesRuleRuleConditionPathConfig>
    Path configuration for Path type condition.
    QueryStringConfigs List<GetRulesRuleRuleConditionQueryStringConfig>
    Query string configuration.
    Type string
    The type of rule condition. Valid values: Host, Path, Header.
    HeaderConfigs []GetRulesRuleRuleConditionHeaderConfig
    Header configuration for Header type condition.
    HostConfigs []GetRulesRuleRuleConditionHostConfig
    Host configuration for host type condition.
    MethodConfigs []GetRulesRuleRuleConditionMethodConfig
    Method configuration for Method type condition.
    PathConfigs []GetRulesRuleRuleConditionPathConfig
    Path configuration for Path type condition.
    QueryStringConfigs []GetRulesRuleRuleConditionQueryStringConfig
    Query string configuration.
    Type string
    The type of rule condition. Valid values: Host, Path, Header.
    headerConfigs List<GetRulesRuleRuleConditionHeaderConfig>
    Header configuration for Header type condition.
    hostConfigs List<GetRulesRuleRuleConditionHostConfig>
    Host configuration for host type condition.
    methodConfigs List<GetRulesRuleRuleConditionMethodConfig>
    Method configuration for Method type condition.
    pathConfigs List<GetRulesRuleRuleConditionPathConfig>
    Path configuration for Path type condition.
    queryStringConfigs List<GetRulesRuleRuleConditionQueryStringConfig>
    Query string configuration.
    type String
    The type of rule condition. Valid values: Host, Path, Header.
    headerConfigs GetRulesRuleRuleConditionHeaderConfig[]
    Header configuration for Header type condition.
    hostConfigs GetRulesRuleRuleConditionHostConfig[]
    Host configuration for host type condition.
    methodConfigs GetRulesRuleRuleConditionMethodConfig[]
    Method configuration for Method type condition.
    pathConfigs GetRulesRuleRuleConditionPathConfig[]
    Path configuration for Path type condition.
    queryStringConfigs GetRulesRuleRuleConditionQueryStringConfig[]
    Query string configuration.
    type string
    The type of rule condition. Valid values: Host, Path, Header.
    header_configs Sequence[GetRulesRuleRuleConditionHeaderConfig]
    Header configuration for Header type condition.
    host_configs Sequence[GetRulesRuleRuleConditionHostConfig]
    Host configuration for host type condition.
    method_configs Sequence[GetRulesRuleRuleConditionMethodConfig]
    Method configuration for Method type condition.
    path_configs Sequence[GetRulesRuleRuleConditionPathConfig]
    Path configuration for Path type condition.
    query_string_configs Sequence[GetRulesRuleRuleConditionQueryStringConfig]
    Query string configuration.
    type str
    The type of rule condition. Valid values: Host, Path, Header.
    headerConfigs List<Property Map>
    Header configuration for Header type condition.
    hostConfigs List<Property Map>
    Host configuration for host type condition.
    methodConfigs List<Property Map>
    Method configuration for Method type condition.
    pathConfigs List<Property Map>
    Path configuration for Path type condition.
    queryStringConfigs List<Property Map>
    Query string configuration.
    type String
    The type of rule condition. Valid values: Host, Path, Header.

    GetRulesRuleRuleConditionHeaderConfig

    Key string
    The query string key.
    Values List<string>
    The list of query string values.
    Key string
    The query string key.
    Values []string
    The list of query string values.
    key String
    The query string key.
    values List<String>
    The list of query string values.
    key string
    The query string key.
    values string[]
    The list of query string values.
    key str
    The query string key.
    values Sequence[str]
    The list of query string values.
    key String
    The query string key.
    values List<String>
    The list of query string values.

    GetRulesRuleRuleConditionHostConfig

    Values List<string>
    The list of query string values.
    Values []string
    The list of query string values.
    values List<String>
    The list of query string values.
    values string[]
    The list of query string values.
    values Sequence[str]
    The list of query string values.
    values List<String>
    The list of query string values.

    GetRulesRuleRuleConditionMethodConfig

    Values List<string>
    The list of query string values.
    Values []string
    The list of query string values.
    values List<String>
    The list of query string values.
    values string[]
    The list of query string values.
    values Sequence[str]
    The list of query string values.
    values List<String>
    The list of query string values.

    GetRulesRuleRuleConditionPathConfig

    Values List<string>
    The list of query string values.
    Values []string
    The list of query string values.
    values List<String>
    The list of query string values.
    values string[]
    The list of query string values.
    values Sequence[str]
    The list of query string values.
    values List<String>
    The list of query string values.

    GetRulesRuleRuleConditionQueryStringConfig

    values List<Property Map>
    The list of query string values.

    GetRulesRuleRuleConditionQueryStringConfigValue

    Key string
    The query string key.
    Value string
    The query string value.
    Key string
    The query string key.
    Value string
    The query string value.
    key String
    The query string key.
    value String
    The query string value.
    key string
    The query string key.
    value string
    The query string value.
    key str
    The query string key.
    value str
    The query string value.
    key String
    The query string key.
    value String
    The query string value.

    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.43 published on Friday, Jan 16, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate