getRule

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getRule

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 getRule(args: GetRuleArgs, opts?: InvokeOptions): Promise<GetRuleResult>
function getRuleOutput(args: GetRuleOutputArgs, opts?: InvokeOptions): Output<GetRuleResult>

def get_rule(id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRuleResult
def get_rule_output(id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRuleResult]

func LookupRule(ctx *Context, args *LookupRuleArgs, opts ...InvokeOption) (*LookupRuleResult, error)
func LookupRuleOutput(ctx *Context, args *LookupRuleOutputArgs, opts ...InvokeOption) LookupRuleResultOutput

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

public static class GetRule 
{
    public static Task<GetRuleResult> InvokeAsync(GetRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
public static Output<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:alb/getRule:getRule
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getRule Result

The following output properties are available:

Description string: Forwarding rule description.
Domain string: Domain name of the forwarding rule.
ForwardGroupConfig Volcengine.GetRuleForwardGroupConfig: Forwarding rule server group configuration.
Id string: Uniquely identifies the resource.
ListenerId string: Listener ID.
Priority int: Standard edition forwarding rule priority.
RedirectConfig Volcengine.GetRuleRedirectConfig: Redirect-related configuration information.
RewriteConfig Volcengine.GetRuleRewriteConfig: Redirect-related configuration information.
RewriteEnabled string: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
RuleAction string: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
RuleActions List<Volcengine.GetRuleRuleAction>: Standard edition forwarding rule action.
RuleConditions List<Volcengine.GetRuleRuleCondition>: Standard edition forwarding rule condition.
RuleId string: Forwarding rule ID.
ServerGroupId string: Backend server group ID associated with the forwarding rule.
TrafficLimitEnabled string: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
TrafficLimitQps int: Requests per second. Range: 100–100000.
Url string: Forwarding rule URL.

Description string: Forwarding rule description.
Domain string: Domain name of the forwarding rule.
ForwardGroupConfig GetRuleForwardGroupConfig: Forwarding rule server group configuration.
Id string: Uniquely identifies the resource.
ListenerId string: Listener ID.
Priority int: Standard edition forwarding rule priority.
RedirectConfig GetRuleRedirectConfig: Redirect-related configuration information.
RewriteConfig GetRuleRewriteConfig: Redirect-related configuration information.
RewriteEnabled string: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
RuleAction string: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
RuleActions []GetRuleRuleAction: Standard edition forwarding rule action.
RuleConditions []GetRuleRuleCondition: Standard edition forwarding rule condition.
RuleId string: Forwarding rule ID.
ServerGroupId string: Backend server group ID associated with the forwarding rule.
TrafficLimitEnabled string: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
TrafficLimitQps int: Requests per second. Range: 100–100000.
Url string: Forwarding rule URL.

description String: Forwarding rule description.
domain String: Domain name of the forwarding rule.
forwardGroupConfig GetRuleForwardGroupConfig: Forwarding rule server group configuration.
id String: Uniquely identifies the resource.
listenerId String: Listener ID.
priority Integer: Standard edition forwarding rule priority.
redirectConfig GetRuleRedirectConfig: Redirect-related configuration information.
rewriteConfig GetRuleRewriteConfig: Redirect-related configuration information.
rewriteEnabled String: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
ruleAction String: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
ruleActions List<GetRuleRuleAction>: Standard edition forwarding rule action.
ruleConditions List<GetRuleRuleCondition>: Standard edition forwarding rule condition.
ruleId String: Forwarding rule ID.
serverGroupId String: Backend server group ID associated with the forwarding rule.
trafficLimitEnabled String: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
trafficLimitQps Integer: Requests per second. Range: 100–100000.
url String: Forwarding rule URL.

description string: Forwarding rule description.
domain string: Domain name of the forwarding rule.
forwardGroupConfig GetRuleForwardGroupConfig: Forwarding rule server group configuration.
id string: Uniquely identifies the resource.
listenerId string: Listener ID.
priority number: Standard edition forwarding rule priority.
redirectConfig GetRuleRedirectConfig: Redirect-related configuration information.
rewriteConfig GetRuleRewriteConfig: Redirect-related configuration information.
rewriteEnabled string: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
ruleAction string: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
ruleActions GetRuleRuleAction[]: Standard edition forwarding rule action.
ruleConditions GetRuleRuleCondition[]: Standard edition forwarding rule condition.
ruleId string: Forwarding rule ID.
serverGroupId string: Backend server group ID associated with the forwarding rule.
trafficLimitEnabled string: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
trafficLimitQps number: Requests per second. Range: 100–100000.
url string: Forwarding rule URL.

description str: Forwarding rule description.
domain str: Domain name of the forwarding rule.
forward_group_config GetRuleForwardGroupConfig: Forwarding rule server group configuration.
id str: Uniquely identifies the resource.
listener_id str: Listener ID.
priority int: Standard edition forwarding rule priority.
redirect_config GetRuleRedirectConfig: Redirect-related configuration information.
rewrite_config GetRuleRewriteConfig: Redirect-related configuration information.
rewrite_enabled str: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
rule_action str: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
rule_actions Sequence[GetRuleRuleAction]: Standard edition forwarding rule action.
rule_conditions Sequence[GetRuleRuleCondition]: Standard edition forwarding rule condition.
rule_id str: Forwarding rule ID.
server_group_id str: Backend server group ID associated with the forwarding rule.
traffic_limit_enabled str: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
traffic_limit_qps int: Requests per second. Range: 100–100000.
url str: Forwarding rule URL.

description String: Forwarding rule description.
domain String: Domain name of the forwarding rule.
forwardGroupConfig Property Map: Forwarding rule server group configuration.
id String: Uniquely identifies the resource.
listenerId String: Listener ID.
priority Number: Standard edition forwarding rule priority.
redirectConfig Property Map: Redirect-related configuration information.
rewriteConfig Property Map: Redirect-related configuration information.
rewriteEnabled String: Forwarding rule rewrite configuration switch. on: enabled. off: disabled.
ruleAction String: Forwarding rule action. Empty: default forward to server group. Redirect: redirect.
ruleActions List<Property Map>: Standard edition forwarding rule action.
ruleConditions List<Property Map>: Standard edition forwarding rule condition.
ruleId String: Forwarding rule ID.
serverGroupId String: Backend server group ID associated with the forwarding rule.
trafficLimitEnabled String: Forwarding rule QPS throttling switch. on: enabled. off: disabled.
trafficLimitQps Number: Requests per second. Range: 100–100000.
url String: Forwarding rule URL.

Supporting Types

GetRuleForwardGroupConfig

ServerGroupTuples List<Volcengine.GetRuleForwardGroupConfigServerGroupTuple>: Destination server group list.
StickySessionEnabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
StickySessionTimeout int: Component session stickiness timeout. Unit: seconds.

ServerGroupTuples []GetRuleForwardGroupConfigServerGroupTuple: Destination server group list.
StickySessionEnabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
StickySessionTimeout int: Component session stickiness timeout. Unit: seconds.

serverGroupTuples List<GetRuleForwardGroupConfigServerGroupTuple>: Destination server group list.
stickySessionEnabled String: Whether to enable inter-group session persistence. on: enabled. off: disabled.
stickySessionTimeout Integer: Component session stickiness timeout. Unit: seconds.

serverGroupTuples GetRuleForwardGroupConfigServerGroupTuple[]: Destination server group list.
stickySessionEnabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
stickySessionTimeout number: Component session stickiness timeout. Unit: seconds.

server_group_tuples Sequence[GetRuleForwardGroupConfigServerGroupTuple]: Destination server group list.
sticky_session_enabled str: Whether to enable inter-group session persistence. on: enabled. off: disabled.
sticky_session_timeout int: Component session stickiness timeout. Unit: seconds.

serverGroupTuples List<Property Map>: Destination server group list.
stickySessionEnabled String: Whether to enable inter-group session persistence. on: enabled. off: disabled.
stickySessionTimeout Number: Component session stickiness timeout. Unit: seconds.

GetRuleForwardGroupConfigServerGroupTuple

ServerGroupId string: Destination server group ID.
Weight int: Server group weight.

ServerGroupId string: Destination server group ID.
Weight int: Server group weight.

serverGroupId String: Destination server group ID.
weight Integer: Server group weight.

serverGroupId string: Destination server group ID.
weight number: Server group weight.

server_group_id str: Destination server group ID.
weight int: Server group weight.

serverGroupId String: Destination server group ID.
weight Number: Server group weight.

GetRuleRedirectConfig

RedirectDomain string: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
RedirectHttpCode string: Redirect status codes: 301, 302, 307, 308.
RedirectPort string: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
RedirectProtocol string: Protocol used for redirect. HTTP, HTTPS.
RedirectUri string: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

RedirectDomain string: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
RedirectHttpCode string: Redirect status codes: 301, 302, 307, 308.
RedirectPort string: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
RedirectProtocol string: Protocol used for redirect. HTTP, HTTPS.
RedirectUri string: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

redirectDomain String: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
redirectHttpCode String: Redirect status codes: 301, 302, 307, 308.
redirectPort String: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
redirectProtocol String: Protocol used for redirect. HTTP, HTTPS.
redirectUri String: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

redirectDomain string: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
redirectHttpCode string: Redirect status codes: 301, 302, 307, 308.
redirectPort string: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
redirectProtocol string: Protocol used for redirect. HTTP, HTTPS.
redirectUri string: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

redirect_domain str: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
redirect_http_code str: Redirect status codes: 301, 302, 307, 308.
redirect_port str: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
redirect_protocol str: Protocol used for redirect. HTTP, HTTPS.
redirect_uri str: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

redirectDomain String: Redirect domain name. If the redirect domain name is left empty when creating or modifying a redirect forwarding rule, the API returns ${host}, which means the redirect domain matches the request domain. However, setting the redirect domain to ${host} is not supported when creating or modifying rules.
redirectHttpCode String: Redirect status codes: 301, 302, 307, 308.
redirectPort String: Redirect port. If the redirect port is left empty when creating or modifying a redirect forwarding rule, the API returns ${port}, which means the redirect port matches the request port (listener port). However, setting the redirect port to ${port} is not supported when creating or modifying rules.
redirectProtocol String: Protocol used for redirect. HTTP, HTTPS.
redirectUri String: Redirect URI. If the redirect URI is left empty when creating or modifying a redirect forwarding rule, the API returns ${requesturi}, which means the redirect URI matches the request URI. However, setting the redirect URI to ${requesturi} is not supported when creating or modifying rules.

GetRuleRewriteConfig

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.

GetRuleRuleAction

FixedResponseConfig Volcengine.GetRuleRuleActionFixedResponseConfig: FixedResponseConfig
ForwardGroupConfig Volcengine.GetRuleRuleActionForwardGroupConfig: ForwardGroupConfig
RedirectConfig Volcengine.GetRuleRuleActionRedirectConfig: RedirectConfig
RewriteConfig Volcengine.GetRuleRuleActionRewriteConfig: RewriteConfig
TrafficLimitConfig Volcengine.GetRuleRuleActionTrafficLimitConfig: TrafficLimitConfig
Type string: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

FixedResponseConfig GetRuleRuleActionFixedResponseConfig: FixedResponseConfig
ForwardGroupConfig GetRuleRuleActionForwardGroupConfig: ForwardGroupConfig
RedirectConfig GetRuleRuleActionRedirectConfig: RedirectConfig
RewriteConfig GetRuleRuleActionRewriteConfig: RewriteConfig
TrafficLimitConfig GetRuleRuleActionTrafficLimitConfig: TrafficLimitConfig
Type string: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

fixedResponseConfig GetRuleRuleActionFixedResponseConfig: FixedResponseConfig
forwardGroupConfig GetRuleRuleActionForwardGroupConfig: ForwardGroupConfig
redirectConfig GetRuleRuleActionRedirectConfig: RedirectConfig
rewriteConfig GetRuleRuleActionRewriteConfig: RewriteConfig
trafficLimitConfig GetRuleRuleActionTrafficLimitConfig: TrafficLimitConfig
type String: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

fixedResponseConfig GetRuleRuleActionFixedResponseConfig: FixedResponseConfig
forwardGroupConfig GetRuleRuleActionForwardGroupConfig: ForwardGroupConfig
redirectConfig GetRuleRuleActionRedirectConfig: RedirectConfig
rewriteConfig GetRuleRuleActionRewriteConfig: RewriteConfig
trafficLimitConfig GetRuleRuleActionTrafficLimitConfig: TrafficLimitConfig
type string: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

fixed_response_config GetRuleRuleActionFixedResponseConfig: FixedResponseConfig
forward_group_config GetRuleRuleActionForwardGroupConfig: ForwardGroupConfig
redirect_config GetRuleRuleActionRedirectConfig: RedirectConfig
rewrite_config GetRuleRuleActionRewriteConfig: RewriteConfig
traffic_limit_config GetRuleRuleActionTrafficLimitConfig: TrafficLimitConfig
type str: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

fixedResponseConfig Property Map: FixedResponseConfig
forwardGroupConfig Property Map: ForwardGroupConfig
redirectConfig Property Map: RedirectConfig
rewriteConfig Property Map: RewriteConfig
trafficLimitConfig Property Map: TrafficLimitConfig
type String: Forwarding rule action types. ForwardGroup: forward to multiple virtual server groups. Redirect: redirect. Rewrite: rewrite. TrafficLimit: traffic limiting.

GetRuleRuleActionFixedResponseConfig

Content string: Fixed response content.
ContentType string: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
HttpCode string: Returned HTTP status code.

Content string: Fixed response content.
ContentType string: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
HttpCode string: Returned HTTP status code.

content String: Fixed response content.
contentType String: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
httpCode String: Returned HTTP status code.

content string: Fixed response content.
contentType string: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
httpCode string: Returned HTTP status code.

content str: Fixed response content.
content_type str: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
http_code str: Returned HTTP status code.

content String: Fixed response content.
contentType String: Format of fixed response content. text/plain, text/css, text/html, application/javascript, application/json
httpCode String: Returned HTTP status code.

GetRuleRuleActionForwardGroupConfig

ServerGroupStickySession Volcengine.GetRuleRuleActionForwardGroupConfigServerGroupStickySession: ServerGroupStickySession
ServerGroupTuples List<Volcengine.GetRuleRuleActionForwardGroupConfigServerGroupTuple>: ServerGroupTuples

ServerGroupStickySession GetRuleRuleActionForwardGroupConfigServerGroupStickySession: ServerGroupStickySession
ServerGroupTuples []GetRuleRuleActionForwardGroupConfigServerGroupTuple: ServerGroupTuples

serverGroupStickySession GetRuleRuleActionForwardGroupConfigServerGroupStickySession: ServerGroupStickySession
serverGroupTuples List<GetRuleRuleActionForwardGroupConfigServerGroupTuple>: ServerGroupTuples

serverGroupStickySession GetRuleRuleActionForwardGroupConfigServerGroupStickySession: ServerGroupStickySession
serverGroupTuples GetRuleRuleActionForwardGroupConfigServerGroupTuple[]: ServerGroupTuples

server_group_sticky_session GetRuleRuleActionForwardGroupConfigServerGroupStickySession: ServerGroupStickySession
server_group_tuples Sequence[GetRuleRuleActionForwardGroupConfigServerGroupTuple]: ServerGroupTuples

serverGroupStickySession Property Map: ServerGroupStickySession
serverGroupTuples List<Property Map>: ServerGroupTuples

GetRuleRuleActionForwardGroupConfigServerGroupStickySession

Enabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
Timeout int: Component session stickiness timeout. Unit: seconds.

Enabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
Timeout int: Component session stickiness timeout. Unit: seconds.

enabled String: Whether to enable inter-group session persistence. on: enabled. off: disabled.
timeout Integer: Component session stickiness timeout. Unit: seconds.

enabled string: Whether to enable inter-group session persistence. on: enabled. off: disabled.
timeout number: Component session stickiness timeout. Unit: seconds.

enabled str: Whether to enable inter-group session persistence. on: enabled. off: disabled.
timeout int: Component session stickiness timeout. Unit: seconds.

enabled String: Whether to enable inter-group session persistence. on: enabled. off: disabled.
timeout Number: Component session stickiness timeout. Unit: seconds.

GetRuleRuleActionForwardGroupConfigServerGroupTuple

ServerGroupId string: Destination server group ID.
Weight int: Server group weight.

ServerGroupId string: Destination server group ID.
Weight int: Server group weight.

serverGroupId String: Destination server group ID.
weight Integer: Server group weight.

serverGroupId string: Destination server group ID.
weight number: Server group weight.

server_group_id str: Destination server group ID.
weight int: Server group weight.

serverGroupId String: Destination server group ID.
weight Number: Server group weight.

GetRuleRuleActionRedirectConfig

Host string: Redirect domain. Only exact domains are supported.
HttpCode string: Redirect status codes supported: 301, 302, 307, 308.
Path string: Redirect URI..
Port string: Redirect port.
Protocol string: Protocol used for redirect. Supports HTTP and HTTPS.

Host string: Redirect domain. Only exact domains are supported.
HttpCode string: Redirect status codes supported: 301, 302, 307, 308.
Path string: Redirect URI..
Port string: Redirect port.
Protocol string: Protocol used for redirect. Supports HTTP and HTTPS.

host String: Redirect domain. Only exact domains are supported.
httpCode String: Redirect status codes supported: 301, 302, 307, 308.
path String: Redirect URI..
port String: Redirect port.
protocol String: Protocol used for redirect. Supports HTTP and HTTPS.

host string: Redirect domain. Only exact domains are supported.
httpCode string: Redirect status codes supported: 301, 302, 307, 308.
path string: Redirect URI..
port string: Redirect port.
protocol string: Protocol used for redirect. Supports HTTP and HTTPS.

host str: Redirect domain. Only exact domains are supported.
http_code str: Redirect status codes supported: 301, 302, 307, 308.
path str: Redirect URI..
port str: Redirect port.
protocol str: Protocol used for redirect. Supports HTTP and HTTPS.

host String: Redirect domain. Only exact domains are supported.
httpCode String: Redirect status codes supported: 301, 302, 307, 308.
path String: Redirect URI..
port String: Redirect port.
protocol String: Protocol used for redirect. Supports HTTP and HTTPS.

GetRuleRuleActionRewriteConfig

Path string: Rewrite path.

Path string: Rewrite path.

path String: Rewrite path.

path string: Rewrite path.

path str: Rewrite path.

path String: Rewrite path.

GetRuleRuleActionTrafficLimitConfig

Qps int: Requests per second.

Qps int: Requests per second.

qps Integer: Requests per second.

qps number: Requests per second.

qps int: Requests per second.

qps Number: Requests per second.

GetRuleRuleCondition

HeaderConfig Volcengine.GetRuleRuleConditionHeaderConfig: HeaderConfig。
HostConfig Volcengine.GetRuleRuleConditionHostConfig: HostConfig。
MethodConfig Volcengine.GetRuleRuleConditionMethodConfig: MethodConfig。
PathConfig Volcengine.GetRuleRuleConditionPathConfig: PathConfig。
QueryStringConfig Volcengine.GetRuleRuleConditionQueryStringConfig: QueryStringConfig。
Type string: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

HeaderConfig GetRuleRuleConditionHeaderConfig: HeaderConfig。
HostConfig GetRuleRuleConditionHostConfig: HostConfig。
MethodConfig GetRuleRuleConditionMethodConfig: MethodConfig。
PathConfig GetRuleRuleConditionPathConfig: PathConfig。
QueryStringConfig GetRuleRuleConditionQueryStringConfig: QueryStringConfig。
Type string: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

headerConfig GetRuleRuleConditionHeaderConfig: HeaderConfig。
hostConfig GetRuleRuleConditionHostConfig: HostConfig。
methodConfig GetRuleRuleConditionMethodConfig: MethodConfig。
pathConfig GetRuleRuleConditionPathConfig: PathConfig。
queryStringConfig GetRuleRuleConditionQueryStringConfig: QueryStringConfig。
type String: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

headerConfig GetRuleRuleConditionHeaderConfig: HeaderConfig。
hostConfig GetRuleRuleConditionHostConfig: HostConfig。
methodConfig GetRuleRuleConditionMethodConfig: MethodConfig。
pathConfig GetRuleRuleConditionPathConfig: PathConfig。
queryStringConfig GetRuleRuleConditionQueryStringConfig: QueryStringConfig。
type string: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

header_config GetRuleRuleConditionHeaderConfig: HeaderConfig。
host_config GetRuleRuleConditionHostConfig: HostConfig。
method_config GetRuleRuleConditionMethodConfig: MethodConfig。
path_config GetRuleRuleConditionPathConfig: PathConfig。
query_string_config GetRuleRuleConditionQueryStringConfig: QueryStringConfig。
type str: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

headerConfig Property Map: HeaderConfig。
hostConfig Property Map: HostConfig。
methodConfig Property Map: MethodConfig。
pathConfig Property Map: PathConfig。
queryStringConfig Property Map: QueryStringConfig。
type String: Standard forwarding rule condition types. Host: domain name. Path: path. Header: HTTP header field. Method: request method. QueryString: query parameter.

GetRuleRuleConditionHeaderConfig

Key string: Header field key.
Values List<string>: Header field value.

Key string: Header field key.
Values []string: Header field value.

key String: Header field key.
values List<String>: Header field value.

key string: Header field key.
values string[]: Header field value.

key str: Header field key.
values Sequence[str]: Header field value.

key String: Header field key.
values List<String>: Header field value.

GetRuleRuleConditionHostConfig

Values List<string>: Domain name of the forwarding rule. Supports wildcard and exact domains.

Values []string: Domain name of the forwarding rule. Supports wildcard and exact domains.

values List<String>: Domain name of the forwarding rule. Supports wildcard and exact domains.

values string[]: Domain name of the forwarding rule. Supports wildcard and exact domains.

values Sequence[str]: Domain name of the forwarding rule. Supports wildcard and exact domains.

values List<String>: Domain name of the forwarding rule. Supports wildcard and exact domains.

GetRuleRuleConditionMethodConfig

Values List<string>: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

Values []string: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

values List<String>: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

values string[]: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

values Sequence[str]: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

values List<String>: Request method. Supports HEAD, GET, POST, OPTIONS, PUT, PATCH, DELETE.

GetRuleRuleConditionPathConfig

Values List<string>: Forwarding rule URL. Only absolute paths are supported.

Values []string: Forwarding rule URL. Only absolute paths are supported.

values List<String>: Forwarding rule URL. Only absolute paths are supported.

values string[]: Forwarding rule URL. Only absolute paths are supported.

values Sequence[str]: Forwarding rule URL. Only absolute paths are supported.

values List<String>: Forwarding rule URL. Only absolute paths are supported.

GetRuleRuleConditionQueryStringConfig

Values List<Volcengine.GetRuleRuleConditionQueryStringConfigValue>: Values。

Values []GetRuleRuleConditionQueryStringConfigValue: Values。

values List<GetRuleRuleConditionQueryStringConfigValue>: Values。

values GetRuleRuleConditionQueryStringConfigValue[]: Values。

values Sequence[GetRuleRuleConditionQueryStringConfigValue]: Values。

values List<Property Map>: Values。

GetRuleRuleConditionQueryStringConfigValue

Key string: Query string key.
Value string: Query string value.

Key string: Query string key.
Value string: Query string value.

key String: Query string key.
value String: Query string value.

key string: Query string key.
value string: Query string value.

key str: Query string key.
value str: Query string value.

key String: Query string key.
value String: Query string value.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.alb.getRule

On this page

On this page

Using getRule

getRule Result

Supporting Types

GetRuleForwardGroupConfig

GetRuleForwardGroupConfigServerGroupTuple

GetRuleRedirectConfig

GetRuleRewriteConfig

GetRuleRuleAction

GetRuleRuleActionFixedResponseConfig

GetRuleRuleActionForwardGroupConfig

GetRuleRuleActionForwardGroupConfigServerGroupStickySession

GetRuleRuleActionForwardGroupConfigServerGroupTuple

GetRuleRuleActionRedirectConfig

GetRuleRuleActionRewriteConfig

GetRuleRuleActionTrafficLimitConfig

GetRuleRuleCondition

GetRuleRuleConditionHeaderConfig

GetRuleRuleConditionHostConfig

GetRuleRuleConditionMethodConfig

GetRuleRuleConditionPathConfig

GetRuleRuleConditionQueryStringConfig

GetRuleRuleConditionQueryStringConfigValue

Package Details

On this page

On this page