1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. alb
  5. Rule
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.alb.Rule

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    ALB 按照您设置的转发规则，对不同特征的访问流量进行分发。您可以为一个监听器配置多条转发规则。基础版 ALB 实例支持基于域名和路径的转发规则。标准版 ALB 实例支持基于域名、路径和 HTTP 标头的转发规则，并支持复合转发条件。

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  albRuleDemo:
    type: bytepluscc:alb:Rule
    name: AlbRuleDemo
    properties:
      description: test-rewrite
      domain: www.xxxx.test.com
      listenerId: lsn-bdwhrmgvcyyo8dv4xxxxxx
      rewriteConfig:
        rewrite_path: /test
      rewriteEnabled: on
      ruleAction: ""
      trafficLimitEnabled: off
      trafficLimitQps: 0
      url: /
      forwardGroupConfig:
        server_group_tuples:
          - serverGroupId: rsp-1pf4pgyq8zitc845wfxxxxxx
            weight: 100
          - serverGroupId: rsp-1pf4pgyq8zitc845wfxxxxxx
            weight: 100
        sticky_session_enabled: on
        sticky_session_timeout: 2000

    Create Rule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
    @overload
def Rule(resource_name: str,
         args: RuleArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Rule(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         listener_id: Optional[str] = None,
         rewrite_config: Optional[RuleRewriteConfigArgs] = None,
         rule_action: Optional[str] = None,
         domain: Optional[str] = None,
         priority: Optional[int] = None,
         redirect_config: Optional[RuleRedirectConfigArgs] = None,
         description: Optional[str] = None,
         rewrite_enabled: Optional[str] = None,
         forward_group_config: Optional[RuleForwardGroupConfigArgs] = None,
         rule_actions: Optional[Sequence[RuleRuleActionArgs]] = None,
         rule_conditions: Optional[Sequence[RuleRuleConditionArgs]] = None,
         server_group_id: Optional[str] = None,
         traffic_limit_enabled: Optional[str] = None,
         traffic_limit_qps: Optional[int] = None,
         url: Optional[str] = None)
    func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
    public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
    public Rule(String name, RuleArgs args)
public Rule(String name, RuleArgs args, CustomResourceOptions options)

    type: bytepluscc:alb:Rule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ruleResource = new Bytepluscc.Alb.Rule("ruleResource", new()
{
    ListenerId = "string",
    RewriteConfig = new Bytepluscc.Alb.Inputs.RuleRewriteConfigArgs
    {
        RewritePath = "string",
    },
    RuleAction = "string",
    Domain = "string",
    Priority = 0,
    RedirectConfig = new Bytepluscc.Alb.Inputs.RuleRedirectConfigArgs
    {
        RedirectDomain = "string",
        RedirectHttpCode = "string",
        RedirectPort = "string",
        RedirectProtocol = "string",
        RedirectUri = "string",
    },
    Description = "string",
    RewriteEnabled = "string",
    ForwardGroupConfig = new Bytepluscc.Alb.Inputs.RuleForwardGroupConfigArgs
    {
        ServerGroupTuples = new[]
        {
            new Bytepluscc.Alb.Inputs.RuleForwardGroupConfigServerGroupTupleArgs
            {
                ServerGroupId = "string",
                Weight = 0,
            },
        },
        StickySessionEnabled = "string",
        StickySessionTimeout = 0,
    },
    RuleActions = new[]
    {
        new Bytepluscc.Alb.Inputs.RuleRuleActionArgs
        {
            FixedResponseConfig = new Bytepluscc.Alb.Inputs.RuleRuleActionFixedResponseConfigArgs
            {
                Content = "string",
                ContentType = "string",
                HttpCode = "string",
            },
            ForwardGroupConfig = new Bytepluscc.Alb.Inputs.RuleRuleActionForwardGroupConfigArgs
            {
                ServerGroupStickySession = new Bytepluscc.Alb.Inputs.RuleRuleActionForwardGroupConfigServerGroupStickySessionArgs
                {
                    Enabled = "string",
                    Timeout = 0,
                },
                ServerGroupTuples = new[]
                {
                    new Bytepluscc.Alb.Inputs.RuleRuleActionForwardGroupConfigServerGroupTupleArgs
                    {
                        ServerGroupId = "string",
                        Weight = 0,
                    },
                },
            },
            RedirectConfig = new Bytepluscc.Alb.Inputs.RuleRuleActionRedirectConfigArgs
            {
                Host = "string",
                HttpCode = "string",
                Path = "string",
                Port = "string",
                Protocol = "string",
            },
            RewriteConfig = new Bytepluscc.Alb.Inputs.RuleRuleActionRewriteConfigArgs
            {
                Path = "string",
            },
            TrafficLimitConfig = new Bytepluscc.Alb.Inputs.RuleRuleActionTrafficLimitConfigArgs
            {
                Qps = 0,
            },
            Type = "string",
        },
    },
    RuleConditions = new[]
    {
        new Bytepluscc.Alb.Inputs.RuleRuleConditionArgs
        {
            HeaderConfig = new Bytepluscc.Alb.Inputs.RuleRuleConditionHeaderConfigArgs
            {
                Key = "string",
                Values = new[]
                {
                    "string",
                },
            },
            HostConfig = new Bytepluscc.Alb.Inputs.RuleRuleConditionHostConfigArgs
            {
                Values = new[]
                {
                    "string",
                },
            },
            MethodConfig = new Bytepluscc.Alb.Inputs.RuleRuleConditionMethodConfigArgs
            {
                Values = new[]
                {
                    "string",
                },
            },
            PathConfig = new Bytepluscc.Alb.Inputs.RuleRuleConditionPathConfigArgs
            {
                Values = new[]
                {
                    "string",
                },
            },
            QueryStringConfig = new Bytepluscc.Alb.Inputs.RuleRuleConditionQueryStringConfigArgs
            {
                Values = new[]
                {
                    new Bytepluscc.Alb.Inputs.RuleRuleConditionQueryStringConfigValueArgs
                    {
                        Key = "string",
                        Value = "string",
                    },
                },
            },
            Type = "string",
        },
    },
    ServerGroupId = "string",
    TrafficLimitEnabled = "string",
    TrafficLimitQps = 0,
    Url = "string",
});

    example, err := alb.NewRule(ctx, "ruleResource", &alb.RuleArgs{
	ListenerId: pulumi.String("string"),
	RewriteConfig: &alb.RuleRewriteConfigArgs{
		RewritePath: pulumi.String("string"),
	},
	RuleAction: pulumi.String("string"),
	Domain:     pulumi.String("string"),
	Priority:   pulumi.Int(0),
	RedirectConfig: &alb.RuleRedirectConfigArgs{
		RedirectDomain:   pulumi.String("string"),
		RedirectHttpCode: pulumi.String("string"),
		RedirectPort:     pulumi.String("string"),
		RedirectProtocol: pulumi.String("string"),
		RedirectUri:      pulumi.String("string"),
	},
	Description:    pulumi.String("string"),
	RewriteEnabled: pulumi.String("string"),
	ForwardGroupConfig: &alb.RuleForwardGroupConfigArgs{
		ServerGroupTuples: alb.RuleForwardGroupConfigServerGroupTupleArray{
			&alb.RuleForwardGroupConfigServerGroupTupleArgs{
				ServerGroupId: pulumi.String("string"),
				Weight:        pulumi.Int(0),
			},
		},
		StickySessionEnabled: pulumi.String("string"),
		StickySessionTimeout: pulumi.Int(0),
	},
	RuleActions: alb.RuleRuleActionArray{
		&alb.RuleRuleActionArgs{
			FixedResponseConfig: &alb.RuleRuleActionFixedResponseConfigArgs{
				Content:     pulumi.String("string"),
				ContentType: pulumi.String("string"),
				HttpCode:    pulumi.String("string"),
			},
			ForwardGroupConfig: &alb.RuleRuleActionForwardGroupConfigArgs{
				ServerGroupStickySession: &alb.RuleRuleActionForwardGroupConfigServerGroupStickySessionArgs{
					Enabled: pulumi.String("string"),
					Timeout: pulumi.Int(0),
				},
				ServerGroupTuples: alb.RuleRuleActionForwardGroupConfigServerGroupTupleArray{
					&alb.RuleRuleActionForwardGroupConfigServerGroupTupleArgs{
						ServerGroupId: pulumi.String("string"),
						Weight:        pulumi.Int(0),
					},
				},
			},
			RedirectConfig: &alb.RuleRuleActionRedirectConfigArgs{
				Host:     pulumi.String("string"),
				HttpCode: pulumi.String("string"),
				Path:     pulumi.String("string"),
				Port:     pulumi.String("string"),
				Protocol: pulumi.String("string"),
			},
			RewriteConfig: &alb.RuleRuleActionRewriteConfigArgs{
				Path: pulumi.String("string"),
			},
			TrafficLimitConfig: &alb.RuleRuleActionTrafficLimitConfigArgs{
				Qps: pulumi.Int(0),
			},
			Type: pulumi.String("string"),
		},
	},
	RuleConditions: alb.RuleRuleConditionArray{
		&alb.RuleRuleConditionArgs{
			HeaderConfig: &alb.RuleRuleConditionHeaderConfigArgs{
				Key: pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			HostConfig: &alb.RuleRuleConditionHostConfigArgs{
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			MethodConfig: &alb.RuleRuleConditionMethodConfigArgs{
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			PathConfig: &alb.RuleRuleConditionPathConfigArgs{
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			QueryStringConfig: &alb.RuleRuleConditionQueryStringConfigArgs{
				Values: alb.RuleRuleConditionQueryStringConfigValueArray{
					&alb.RuleRuleConditionQueryStringConfigValueArgs{
						Key:   pulumi.String("string"),
						Value: pulumi.String("string"),
					},
				},
			},
			Type: pulumi.String("string"),
		},
	},
	ServerGroupId:       pulumi.String("string"),
	TrafficLimitEnabled: pulumi.String("string"),
	TrafficLimitQps:     pulumi.Int(0),
	Url:                 pulumi.String("string"),
})

    var ruleResource = new com.byteplus.bytepluscc.alb.Rule("ruleResource", com.byteplus.bytepluscc.alb.RuleArgs.builder()
    .listenerId("string")
    .rewriteConfig(RuleRewriteConfigArgs.builder()
        .rewritePath("string")
        .build())
    .ruleAction("string")
    .domain("string")
    .priority(0)
    .redirectConfig(RuleRedirectConfigArgs.builder()
        .redirectDomain("string")
        .redirectHttpCode("string")
        .redirectPort("string")
        .redirectProtocol("string")
        .redirectUri("string")
        .build())
    .description("string")
    .rewriteEnabled("string")
    .forwardGroupConfig(RuleForwardGroupConfigArgs.builder()
        .serverGroupTuples(RuleForwardGroupConfigServerGroupTupleArgs.builder()
            .serverGroupId("string")
            .weight(0)
            .build())
        .stickySessionEnabled("string")
        .stickySessionTimeout(0)
        .build())
    .ruleActions(RuleRuleActionArgs.builder()
        .fixedResponseConfig(RuleRuleActionFixedResponseConfigArgs.builder()
            .content("string")
            .contentType("string")
            .httpCode("string")
            .build())
        .forwardGroupConfig(RuleRuleActionForwardGroupConfigArgs.builder()
            .serverGroupStickySession(RuleRuleActionForwardGroupConfigServerGroupStickySessionArgs.builder()
                .enabled("string")
                .timeout(0)
                .build())
            .serverGroupTuples(RuleRuleActionForwardGroupConfigServerGroupTupleArgs.builder()
                .serverGroupId("string")
                .weight(0)
                .build())
            .build())
        .redirectConfig(RuleRuleActionRedirectConfigArgs.builder()
            .host("string")
            .httpCode("string")
            .path("string")
            .port("string")
            .protocol("string")
            .build())
        .rewriteConfig(RuleRuleActionRewriteConfigArgs.builder()
            .path("string")
            .build())
        .trafficLimitConfig(RuleRuleActionTrafficLimitConfigArgs.builder()
            .qps(0)
            .build())
        .type("string")
        .build())
    .ruleConditions(RuleRuleConditionArgs.builder()
        .headerConfig(RuleRuleConditionHeaderConfigArgs.builder()
            .key("string")
            .values("string")
            .build())
        .hostConfig(RuleRuleConditionHostConfigArgs.builder()
            .values("string")
            .build())
        .methodConfig(RuleRuleConditionMethodConfigArgs.builder()
            .values("string")
            .build())
        .pathConfig(RuleRuleConditionPathConfigArgs.builder()
            .values("string")
            .build())
        .queryStringConfig(RuleRuleConditionQueryStringConfigArgs.builder()
            .values(RuleRuleConditionQueryStringConfigValueArgs.builder()
                .key("string")
                .value("string")
                .build())
            .build())
        .type("string")
        .build())
    .serverGroupId("string")
    .trafficLimitEnabled("string")
    .trafficLimitQps(0)
    .url("string")
    .build());

    rule_resource = bytepluscc.alb.Rule("ruleResource",
    listener_id="string",
    rewrite_config={
        "rewrite_path": "string",
    },
    rule_action="string",
    domain="string",
    priority=0,
    redirect_config={
        "redirect_domain": "string",
        "redirect_http_code": "string",
        "redirect_port": "string",
        "redirect_protocol": "string",
        "redirect_uri": "string",
    },
    description="string",
    rewrite_enabled="string",
    forward_group_config={
        "server_group_tuples": [{
            "server_group_id": "string",
            "weight": 0,
        }],
        "sticky_session_enabled": "string",
        "sticky_session_timeout": 0,
    },
    rule_actions=[{
        "fixed_response_config": {
            "content": "string",
            "content_type": "string",
            "http_code": "string",
        },
        "forward_group_config": {
            "server_group_sticky_session": {
                "enabled": "string",
                "timeout": 0,
            },
            "server_group_tuples": [{
                "server_group_id": "string",
                "weight": 0,
            }],
        },
        "redirect_config": {
            "host": "string",
            "http_code": "string",
            "path": "string",
            "port": "string",
            "protocol": "string",
        },
        "rewrite_config": {
            "path": "string",
        },
        "traffic_limit_config": {
            "qps": 0,
        },
        "type": "string",
    }],
    rule_conditions=[{
        "header_config": {
            "key": "string",
            "values": ["string"],
        },
        "host_config": {
            "values": ["string"],
        },
        "method_config": {
            "values": ["string"],
        },
        "path_config": {
            "values": ["string"],
        },
        "query_string_config": {
            "values": [{
                "key": "string",
                "value": "string",
            }],
        },
        "type": "string",
    }],
    server_group_id="string",
    traffic_limit_enabled="string",
    traffic_limit_qps=0,
    url="string")

    const ruleResource = new bytepluscc.alb.Rule("ruleResource", {
    listenerId: "string",
    rewriteConfig: {
        rewritePath: "string",
    },
    ruleAction: "string",
    domain: "string",
    priority: 0,
    redirectConfig: {
        redirectDomain: "string",
        redirectHttpCode: "string",
        redirectPort: "string",
        redirectProtocol: "string",
        redirectUri: "string",
    },
    description: "string",
    rewriteEnabled: "string",
    forwardGroupConfig: {
        serverGroupTuples: [{
            serverGroupId: "string",
            weight: 0,
        }],
        stickySessionEnabled: "string",
        stickySessionTimeout: 0,
    },
    ruleActions: [{
        fixedResponseConfig: {
            content: "string",
            contentType: "string",
            httpCode: "string",
        },
        forwardGroupConfig: {
            serverGroupStickySession: {
                enabled: "string",
                timeout: 0,
            },
            serverGroupTuples: [{
                serverGroupId: "string",
                weight: 0,
            }],
        },
        redirectConfig: {
            host: "string",
            httpCode: "string",
            path: "string",
            port: "string",
            protocol: "string",
        },
        rewriteConfig: {
            path: "string",
        },
        trafficLimitConfig: {
            qps: 0,
        },
        type: "string",
    }],
    ruleConditions: [{
        headerConfig: {
            key: "string",
            values: ["string"],
        },
        hostConfig: {
            values: ["string"],
        },
        methodConfig: {
            values: ["string"],
        },
        pathConfig: {
            values: ["string"],
        },
        queryStringConfig: {
            values: [{
                key: "string",
                value: "string",
            }],
        },
        type: "string",
    }],
    serverGroupId: "string",
    trafficLimitEnabled: "string",
    trafficLimitQps: 0,
    url: "string",
});

    type: bytepluscc:alb:Rule
properties:
    description: string
    domain: string
    forwardGroupConfig:
        serverGroupTuples:
            - serverGroupId: string
              weight: 0
        stickySessionEnabled: string
        stickySessionTimeout: 0
    listenerId: string
    priority: 0
    redirectConfig:
        redirectDomain: string
        redirectHttpCode: string
        redirectPort: string
        redirectProtocol: string
        redirectUri: string
    rewriteConfig:
        rewritePath: string
    rewriteEnabled: string
    ruleAction: string
    ruleActions:
        - fixedResponseConfig:
            content: string
            contentType: string
            httpCode: string
          forwardGroupConfig:
            serverGroupStickySession:
                enabled: string
                timeout: 0
            serverGroupTuples:
                - serverGroupId: string
                  weight: 0
          redirectConfig:
            host: string
            httpCode: string
            path: string
            port: string
            protocol: string
          rewriteConfig:
            path: string
          trafficLimitConfig:
            qps: 0
          type: string
    ruleConditions:
        - headerConfig:
            key: string
            values:
                - string
          hostConfig:
            values:
                - string
          methodConfig:
            values:
                - string
          pathConfig:
            values:
                - string
          queryStringConfig:
            values:
                - key: string
                  value: string
          type: string
    serverGroupId: string
    trafficLimitEnabled: string
    trafficLimitQps: 0
    url: string

    Rule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Rule resource accepts the following input properties:

    ListenerId string
    监听器ID。
    Description string
    转发规则的描述。
    Domain string
    转发规则的域名。
    ForwardGroupConfig Byteplus.RuleForwardGroupConfig
    转发规则服务器组配置
    Priority int
    标准版转发规则优先级。
    RedirectConfig Byteplus.RuleRedirectConfig
    重定向相关配置信息。
    RewriteConfig Byteplus.RuleRewriteConfig
    重定向相关配置信息。
    RewriteEnabled string
    转发规则重写配置开关。on：开启。off：关闭。
    RuleAction string
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    RuleActions List<Byteplus.RuleRuleAction>
    RuleConditions List<Byteplus.RuleRuleCondition>
    ServerGroupId string
    转发规则关联的后端服务器组ID。
    TrafficLimitEnabled string
    转发规则 QPS 限速开关。on：开启。off：关闭。
    TrafficLimitQps int
    每秒请求数。取值范围：100～100000。
    Url string
    转发规则的URL。
    ListenerId string
    监听器ID。
    Description string
    转发规则的描述。
    Domain string
    转发规则的域名。
    ForwardGroupConfig RuleForwardGroupConfigArgs
    转发规则服务器组配置
    Priority int
    标准版转发规则优先级。
    RedirectConfig RuleRedirectConfigArgs
    重定向相关配置信息。
    RewriteConfig RuleRewriteConfigArgs
    重定向相关配置信息。
    RewriteEnabled string
    转发规则重写配置开关。on：开启。off：关闭。
    RuleAction string
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    RuleActions []RuleRuleActionArgs
    RuleConditions []RuleRuleConditionArgs
    ServerGroupId string
    转发规则关联的后端服务器组ID。
    TrafficLimitEnabled string
    转发规则 QPS 限速开关。on：开启。off：关闭。
    TrafficLimitQps int
    每秒请求数。取值范围：100～100000。
    Url string
    转发规则的URL。
    listenerId String
    监听器ID。
    description String
    转发规则的描述。
    domain String
    转发规则的域名。
    forwardGroupConfig RuleForwardGroupConfig
    转发规则服务器组配置
    priority Integer
    标准版转发规则优先级。
    redirectConfig RuleRedirectConfig
    重定向相关配置信息。
    rewriteConfig RuleRewriteConfig
    重定向相关配置信息。
    rewriteEnabled String
    转发规则重写配置开关。on：开启。off：关闭。
    ruleAction String
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    ruleActions List<RuleRuleAction>
    ruleConditions List<RuleRuleCondition>
    serverGroupId String
    转发规则关联的后端服务器组ID。
    trafficLimitEnabled String
    转发规则 QPS 限速开关。on：开启。off：关闭。
    trafficLimitQps Integer
    每秒请求数。取值范围：100～100000。
    url String
    转发规则的URL。
    listenerId string
    监听器ID。
    description string
    转发规则的描述。
    domain string
    转发规则的域名。
    forwardGroupConfig RuleForwardGroupConfig
    转发规则服务器组配置
    priority number
    标准版转发规则优先级。
    redirectConfig RuleRedirectConfig
    重定向相关配置信息。
    rewriteConfig RuleRewriteConfig
    重定向相关配置信息。
    rewriteEnabled string
    转发规则重写配置开关。on：开启。off：关闭。
    ruleAction string
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    ruleActions RuleRuleAction[]
    ruleConditions RuleRuleCondition[]
    serverGroupId string
    转发规则关联的后端服务器组ID。
    trafficLimitEnabled string
    转发规则 QPS 限速开关。on：开启。off：关闭。
    trafficLimitQps number
    每秒请求数。取值范围：100～100000。
    url string
    转发规则的URL。
    listener_id str
    监听器ID。
    description str
    转发规则的描述。
    domain str
    转发规则的域名。
    forward_group_config RuleForwardGroupConfigArgs
    转发规则服务器组配置
    priority int
    标准版转发规则优先级。
    redirect_config RuleRedirectConfigArgs
    重定向相关配置信息。
    rewrite_config RuleRewriteConfigArgs
    重定向相关配置信息。
    rewrite_enabled str
    转发规则重写配置开关。on：开启。off：关闭。
    rule_action str
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    rule_actions Sequence[RuleRuleActionArgs]
    rule_conditions Sequence[RuleRuleConditionArgs]
    server_group_id str
    转发规则关联的后端服务器组ID。
    traffic_limit_enabled str
    转发规则 QPS 限速开关。on：开启。off：关闭。
    traffic_limit_qps int
    每秒请求数。取值范围：100～100000。
    url str
    转发规则的URL。
    listenerId String
    监听器ID。
    description String
    转发规则的描述。
    domain String
    转发规则的域名。
    forwardGroupConfig Property Map
    转发规则服务器组配置
    priority Number
    标准版转发规则优先级。
    redirectConfig Property Map
    重定向相关配置信息。
    rewriteConfig Property Map
    重定向相关配置信息。
    rewriteEnabled String
    转发规则重写配置开关。on：开启。off：关闭。
    ruleAction String
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    ruleActions List<Property Map>
    ruleConditions List<Property Map>
    serverGroupId String
    转发规则关联的后端服务器组ID。
    trafficLimitEnabled String
    转发规则 QPS 限速开关。on：开启。off：关闭。
    trafficLimitQps Number
    每秒请求数。取值范围：100～100000。
    url String
    转发规则的URL。

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Rule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    转发规则ID。
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId string
    转发规则ID。
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    转发规则ID。
    id string
    The provider-assigned unique ID for this managed resource.
    ruleId string
    转发规则ID。
    id str
    The provider-assigned unique ID for this managed resource.
    rule_id str
    转发规则ID。
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId String
    转发规则ID。

    Look up Existing Rule Resource

    Get an existing Rule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RuleState, opts?: CustomResourceOptions): Rule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        domain: Optional[str] = None,
        forward_group_config: Optional[RuleForwardGroupConfigArgs] = None,
        listener_id: Optional[str] = None,
        priority: Optional[int] = None,
        redirect_config: Optional[RuleRedirectConfigArgs] = None,
        rewrite_config: Optional[RuleRewriteConfigArgs] = None,
        rewrite_enabled: Optional[str] = None,
        rule_action: Optional[str] = None,
        rule_actions: Optional[Sequence[RuleRuleActionArgs]] = None,
        rule_conditions: Optional[Sequence[RuleRuleConditionArgs]] = None,
        rule_id: Optional[str] = None,
        server_group_id: Optional[str] = None,
        traffic_limit_enabled: Optional[str] = None,
        traffic_limit_qps: Optional[int] = None,
        url: Optional[str] = None) -> Rule
    func GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)
    public static Rule Get(string name, Input<string> id, RuleState? state, CustomResourceOptions? opts = null)
    public static Rule get(String name, Output<String> id, RuleState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:alb:Rule    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    转发规则的描述。
    Domain string
    转发规则的域名。
    ForwardGroupConfig Byteplus.RuleForwardGroupConfig
    转发规则服务器组配置
    ListenerId string
    监听器ID。
    Priority int
    标准版转发规则优先级。
    RedirectConfig Byteplus.RuleRedirectConfig
    重定向相关配置信息。
    RewriteConfig Byteplus.RuleRewriteConfig
    重定向相关配置信息。
    RewriteEnabled string
    转发规则重写配置开关。on：开启。off：关闭。
    RuleAction string
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    RuleActions List<Byteplus.RuleRuleAction>
    RuleConditions List<Byteplus.RuleRuleCondition>
    RuleId string
    转发规则ID。
    ServerGroupId string
    转发规则关联的后端服务器组ID。
    TrafficLimitEnabled string
    转发规则 QPS 限速开关。on：开启。off：关闭。
    TrafficLimitQps int
    每秒请求数。取值范围：100～100000。
    Url string
    转发规则的URL。
    Description string
    转发规则的描述。
    Domain string
    转发规则的域名。
    ForwardGroupConfig RuleForwardGroupConfigArgs
    转发规则服务器组配置
    ListenerId string
    监听器ID。
    Priority int
    标准版转发规则优先级。
    RedirectConfig RuleRedirectConfigArgs
    重定向相关配置信息。
    RewriteConfig RuleRewriteConfigArgs
    重定向相关配置信息。
    RewriteEnabled string
    转发规则重写配置开关。on：开启。off：关闭。
    RuleAction string
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    RuleActions []RuleRuleActionArgs
    RuleConditions []RuleRuleConditionArgs
    RuleId string
    转发规则ID。
    ServerGroupId string
    转发规则关联的后端服务器组ID。
    TrafficLimitEnabled string
    转发规则 QPS 限速开关。on：开启。off：关闭。
    TrafficLimitQps int
    每秒请求数。取值范围：100～100000。
    Url string
    转发规则的URL。
    description String
    转发规则的描述。
    domain String
    转发规则的域名。
    forwardGroupConfig RuleForwardGroupConfig
    转发规则服务器组配置
    listenerId String
    监听器ID。
    priority Integer
    标准版转发规则优先级。
    redirectConfig RuleRedirectConfig
    重定向相关配置信息。
    rewriteConfig RuleRewriteConfig
    重定向相关配置信息。
    rewriteEnabled String
    转发规则重写配置开关。on：开启。off：关闭。
    ruleAction String
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    ruleActions List<RuleRuleAction>
    ruleConditions List<RuleRuleCondition>
    ruleId String
    转发规则ID。
    serverGroupId String
    转发规则关联的后端服务器组ID。
    trafficLimitEnabled String
    转发规则 QPS 限速开关。on：开启。off：关闭。
    trafficLimitQps Integer
    每秒请求数。取值范围：100～100000。
    url String
    转发规则的URL。
    description string
    转发规则的描述。
    domain string
    转发规则的域名。
    forwardGroupConfig RuleForwardGroupConfig
    转发规则服务器组配置
    listenerId string
    监听器ID。
    priority number
    标准版转发规则优先级。
    redirectConfig RuleRedirectConfig
    重定向相关配置信息。
    rewriteConfig RuleRewriteConfig
    重定向相关配置信息。
    rewriteEnabled string
    转发规则重写配置开关。on：开启。off：关闭。
    ruleAction string
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    ruleActions RuleRuleAction[]
    ruleConditions RuleRuleCondition[]
    ruleId string
    转发规则ID。
    serverGroupId string
    转发规则关联的后端服务器组ID。
    trafficLimitEnabled string
    转发规则 QPS 限速开关。on：开启。off：关闭。
    trafficLimitQps number
    每秒请求数。取值范围：100～100000。
    url string
    转发规则的URL。
    description str
    转发规则的描述。
    domain str
    转发规则的域名。
    forward_group_config RuleForwardGroupConfigArgs
    转发规则服务器组配置
    listener_id str
    监听器ID。
    priority int
    标准版转发规则优先级。
    redirect_config RuleRedirectConfigArgs
    重定向相关配置信息。
    rewrite_config RuleRewriteConfigArgs
    重定向相关配置信息。
    rewrite_enabled str
    转发规则重写配置开关。on：开启。off：关闭。
    rule_action str
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    rule_actions Sequence[RuleRuleActionArgs]
    rule_conditions Sequence[RuleRuleConditionArgs]
    rule_id str
    转发规则ID。
    server_group_id str
    转发规则关联的后端服务器组ID。
    traffic_limit_enabled str
    转发规则 QPS 限速开关。on：开启。off：关闭。
    traffic_limit_qps int
    每秒请求数。取值范围：100～100000。
    url str
    转发规则的URL。
    description String
    转发规则的描述。
    domain String
    转发规则的域名。
    forwardGroupConfig Property Map
    转发规则服务器组配置
    listenerId String
    监听器ID。
    priority Number
    标准版转发规则优先级。
    redirectConfig Property Map
    重定向相关配置信息。
    rewriteConfig Property Map
    重定向相关配置信息。
    rewriteEnabled String
    转发规则重写配置开关。on：开启。off：关闭。
    ruleAction String
    转发规则动作。空：默认转发至服务器组。Redirect：重定向。
    ruleActions List<Property Map>
    ruleConditions List<Property Map>
    ruleId String
    转发规则ID。
    serverGroupId String
    转发规则关联的后端服务器组ID。
    trafficLimitEnabled String
    转发规则 QPS 限速开关。on：开启。off：关闭。
    trafficLimitQps Number
    每秒请求数。取值范围：100～100000。
    url String
    转发规则的URL。

    Supporting Types

    RuleForwardGroupConfig, RuleForwardGroupConfigArgs

    ServerGroupTuples List<Byteplus.RuleForwardGroupConfigServerGroupTuple>
    StickySessionEnabled string
    是否开启组间会话保持。on：开启。off：不开启。
    StickySessionTimeout int
    组件回话保持的超时时间。单位：秒。
    ServerGroupTuples []RuleForwardGroupConfigServerGroupTuple
    StickySessionEnabled string
    是否开启组间会话保持。on：开启。off：不开启。
    StickySessionTimeout int
    组件回话保持的超时时间。单位：秒。
    serverGroupTuples List<RuleForwardGroupConfigServerGroupTuple>
    stickySessionEnabled String
    是否开启组间会话保持。on：开启。off：不开启。
    stickySessionTimeout Integer
    组件回话保持的超时时间。单位：秒。
    serverGroupTuples RuleForwardGroupConfigServerGroupTuple[]
    stickySessionEnabled string
    是否开启组间会话保持。on：开启。off：不开启。
    stickySessionTimeout number
    组件回话保持的超时时间。单位：秒。
    server_group_tuples Sequence[RuleForwardGroupConfigServerGroupTuple]
    sticky_session_enabled str
    是否开启组间会话保持。on：开启。off：不开启。
    sticky_session_timeout int
    组件回话保持的超时时间。单位：秒。
    serverGroupTuples List<Property Map>
    stickySessionEnabled String
    是否开启组间会话保持。on：开启。off：不开启。
    stickySessionTimeout Number
    组件回话保持的超时时间。单位：秒。

    RuleForwardGroupConfigServerGroupTuple, RuleForwardGroupConfigServerGroupTupleArgs

    ServerGroupId string
    转发到的目的服务器组 ID。
    Weight int
    服务器组权重。
    ServerGroupId string
    转发到的目的服务器组 ID。
    Weight int
    服务器组权重。
    serverGroupId String
    转发到的目的服务器组 ID。
    weight Integer
    服务器组权重。
    serverGroupId string
    转发到的目的服务器组 ID。
    weight number
    服务器组权重。
    server_group_id str
    转发到的目的服务器组 ID。
    weight int
    服务器组权重。
    serverGroupId String
    转发到的目的服务器组 ID。
    weight Number
    服务器组权重。

    RuleRedirectConfig, RuleRedirectConfigArgs

    RedirectDomain string
    重定向的域名。若创建/修改重定向类型的转发规则时，重定向域名设置为空，接口会返回${host}，该变量含义为重定向域名与请求域名保持一致，但不支持创建/修改时，将重定向域名设置为${host}.。
    RedirectHttpCode string
    重定向状态码。301、302、307、308。
    RedirectPort string
    重定向的端口。若创建/修改重定向类型的转发规则时，重定向端口设置为空，接口会返回${port}，该变量含义为重定向端口与请求端口（监听器端口）保持一致，但不支持创建/修改时，将重定向端口设置为${port}.。
    RedirectProtocol string
    重定向使用的协议。HTTP、HTTPS。
    RedirectUri string
    重定向的URI。若创建/修改重定向类型的转发规则时，重定向uri设置为空，接口会返回${requesturi}，该变量含义为重定向uri与请求uri保持一致，但不支持创建/修改时，将重定向uri设置为${requesturi}.。
    RedirectDomain string
    重定向的域名。若创建/修改重定向类型的转发规则时，重定向域名设置为空，接口会返回${host}，该变量含义为重定向域名与请求域名保持一致，但不支持创建/修改时，将重定向域名设置为${host}.。
    RedirectHttpCode string
    重定向状态码。301、302、307、308。
    RedirectPort string
    重定向的端口。若创建/修改重定向类型的转发规则时，重定向端口设置为空，接口会返回${port}，该变量含义为重定向端口与请求端口（监听器端口）保持一致，但不支持创建/修改时，将重定向端口设置为${port}.。
    RedirectProtocol string
    重定向使用的协议。HTTP、HTTPS。
    RedirectUri string
    重定向的URI。若创建/修改重定向类型的转发规则时，重定向uri设置为空，接口会返回${requesturi}，该变量含义为重定向uri与请求uri保持一致，但不支持创建/修改时，将重定向uri设置为${requesturi}.。
    redirectDomain String
    重定向的域名。若创建/修改重定向类型的转发规则时，重定向域名设置为空，接口会返回${host}，该变量含义为重定向域名与请求域名保持一致，但不支持创建/修改时，将重定向域名设置为${host}.。
    redirectHttpCode String
    重定向状态码。301、302、307、308。
    redirectPort String
    重定向的端口。若创建/修改重定向类型的转发规则时，重定向端口设置为空，接口会返回${port}，该变量含义为重定向端口与请求端口（监听器端口）保持一致，但不支持创建/修改时，将重定向端口设置为${port}.。
    redirectProtocol String
    重定向使用的协议。HTTP、HTTPS。
    redirectUri String
    重定向的URI。若创建/修改重定向类型的转发规则时，重定向uri设置为空，接口会返回${requesturi}，该变量含义为重定向uri与请求uri保持一致，但不支持创建/修改时，将重定向uri设置为${requesturi}.。
    redirectDomain string
    重定向的域名。若创建/修改重定向类型的转发规则时，重定向域名设置为空，接口会返回${host}，该变量含义为重定向域名与请求域名保持一致，但不支持创建/修改时，将重定向域名设置为${host}.。
    redirectHttpCode string
    重定向状态码。301、302、307、308。
    redirectPort string
    重定向的端口。若创建/修改重定向类型的转发规则时，重定向端口设置为空，接口会返回${port}，该变量含义为重定向端口与请求端口（监听器端口）保持一致，但不支持创建/修改时，将重定向端口设置为${port}.。
    redirectProtocol string
    重定向使用的协议。HTTP、HTTPS。
    redirectUri string
    重定向的URI。若创建/修改重定向类型的转发规则时，重定向uri设置为空，接口会返回${requesturi}，该变量含义为重定向uri与请求uri保持一致，但不支持创建/修改时，将重定向uri设置为${requesturi}.。
    redirect_domain str
    重定向的域名。若创建/修改重定向类型的转发规则时，重定向域名设置为空，接口会返回${host}，该变量含义为重定向域名与请求域名保持一致，但不支持创建/修改时，将重定向域名设置为${host}.。
    redirect_http_code str
    重定向状态码。301、302、307、308。
    redirect_port str
    重定向的端口。若创建/修改重定向类型的转发规则时，重定向端口设置为空，接口会返回${port}，该变量含义为重定向端口与请求端口（监听器端口）保持一致，但不支持创建/修改时，将重定向端口设置为${port}.。
    redirect_protocol str
    重定向使用的协议。HTTP、HTTPS。
    redirect_uri str
    重定向的URI。若创建/修改重定向类型的转发规则时，重定向uri设置为空，接口会返回${requesturi}，该变量含义为重定向uri与请求uri保持一致，但不支持创建/修改时，将重定向uri设置为${requesturi}.。
    redirectDomain String
    重定向的域名。若创建/修改重定向类型的转发规则时，重定向域名设置为空，接口会返回${host}，该变量含义为重定向域名与请求域名保持一致，但不支持创建/修改时，将重定向域名设置为${host}.。
    redirectHttpCode String
    重定向状态码。301、302、307、308。
    redirectPort String
    重定向的端口。若创建/修改重定向类型的转发规则时，重定向端口设置为空，接口会返回${port}，该变量含义为重定向端口与请求端口（监听器端口）保持一致，但不支持创建/修改时，将重定向端口设置为${port}.。
    redirectProtocol String
    重定向使用的协议。HTTP、HTTPS。
    redirectUri String
    重定向的URI。若创建/修改重定向类型的转发规则时，重定向uri设置为空，接口会返回${requesturi}，该变量含义为重定向uri与请求uri保持一致，但不支持创建/修改时，将重定向uri设置为${requesturi}.。

    RuleRewriteConfig, RuleRewriteConfigArgs

    RewritePath string
    重写路径。
    RewritePath string
    重写路径。
    rewritePath String
    重写路径。
    rewritePath string
    重写路径。
    rewrite_path str
    重写路径。
    rewritePath String
    重写路径。

    RuleRuleAction, RuleRuleActionArgs

    FixedResponseConfig Byteplus.RuleRuleActionFixedResponseConfig
    FixedResponseConfig
    ForwardGroupConfig Byteplus.RuleRuleActionForwardGroupConfig
    ForwardGroupConfig
    RedirectConfig Byteplus.RuleRuleActionRedirectConfig
    RedirectConfig
    RewriteConfig Byteplus.RuleRuleActionRewriteConfig
    RewriteConfig
    TrafficLimitConfig Byteplus.RuleRuleActionTrafficLimitConfig
    TrafficLimitConfig
    Type string
    转发规则动作类型。ForwardGroup：转发至多个虚拟服务器组。Redirect： 重定向。Rewrite： 重写。TrafficLimit：流量限速。
    FixedResponseConfig RuleRuleActionFixedResponseConfig
    FixedResponseConfig
    ForwardGroupConfig RuleRuleActionForwardGroupConfig
    ForwardGroupConfig
    RedirectConfig RuleRuleActionRedirectConfig
    RedirectConfig
    RewriteConfig RuleRuleActionRewriteConfig
    RewriteConfig
    TrafficLimitConfig RuleRuleActionTrafficLimitConfig
    TrafficLimitConfig
    Type string
    转发规则动作类型。ForwardGroup：转发至多个虚拟服务器组。Redirect： 重定向。Rewrite： 重写。TrafficLimit：流量限速。
    fixedResponseConfig RuleRuleActionFixedResponseConfig
    FixedResponseConfig
    forwardGroupConfig RuleRuleActionForwardGroupConfig
    ForwardGroupConfig
    redirectConfig RuleRuleActionRedirectConfig
    RedirectConfig
    rewriteConfig RuleRuleActionRewriteConfig
    RewriteConfig
    trafficLimitConfig RuleRuleActionTrafficLimitConfig
    TrafficLimitConfig
    type String
    转发规则动作类型。ForwardGroup：转发至多个虚拟服务器组。Redirect： 重定向。Rewrite： 重写。TrafficLimit：流量限速。
    fixedResponseConfig RuleRuleActionFixedResponseConfig
    FixedResponseConfig
    forwardGroupConfig RuleRuleActionForwardGroupConfig
    ForwardGroupConfig
    redirectConfig RuleRuleActionRedirectConfig
    RedirectConfig
    rewriteConfig RuleRuleActionRewriteConfig
    RewriteConfig
    trafficLimitConfig RuleRuleActionTrafficLimitConfig
    TrafficLimitConfig
    type string
    转发规则动作类型。ForwardGroup：转发至多个虚拟服务器组。Redirect： 重定向。Rewrite： 重写。TrafficLimit：流量限速。
    fixed_response_config RuleRuleActionFixedResponseConfig
    FixedResponseConfig
    forward_group_config RuleRuleActionForwardGroupConfig
    ForwardGroupConfig
    redirect_config RuleRuleActionRedirectConfig
    RedirectConfig
    rewrite_config RuleRuleActionRewriteConfig
    RewriteConfig
    traffic_limit_config RuleRuleActionTrafficLimitConfig
    TrafficLimitConfig
    type str
    转发规则动作类型。ForwardGroup：转发至多个虚拟服务器组。Redirect： 重定向。Rewrite： 重写。TrafficLimit：流量限速。
    fixedResponseConfig Property Map
    FixedResponseConfig
    forwardGroupConfig Property Map
    ForwardGroupConfig
    redirectConfig Property Map
    RedirectConfig
    rewriteConfig Property Map
    RewriteConfig
    trafficLimitConfig Property Map
    TrafficLimitConfig
    type String
    转发规则动作类型。ForwardGroup：转发至多个虚拟服务器组。Redirect： 重定向。Rewrite： 重写。TrafficLimit：流量限速。

    RuleRuleActionFixedResponseConfig, RuleRuleActionFixedResponseConfigArgs

    Content string
    返回的固定内容。
    ContentType string
    返回的固定内容的格式。text/plain、text/css、text/html、application/javascript、application/json
    HttpCode string
    返回的 HTTP 状态码。
    Content string
    返回的固定内容。
    ContentType string
    返回的固定内容的格式。text/plain、text/css、text/html、application/javascript、application/json
    HttpCode string
    返回的 HTTP 状态码。
    content String
    返回的固定内容。
    contentType String
    返回的固定内容的格式。text/plain、text/css、text/html、application/javascript、application/json
    httpCode String
    返回的 HTTP 状态码。
    content string
    返回的固定内容。
    contentType string
    返回的固定内容的格式。text/plain、text/css、text/html、application/javascript、application/json
    httpCode string
    返回的 HTTP 状态码。
    content str
    返回的固定内容。
    content_type str
    返回的固定内容的格式。text/plain、text/css、text/html、application/javascript、application/json
    http_code str
    返回的 HTTP 状态码。
    content String
    返回的固定内容。
    contentType String
    返回的固定内容的格式。text/plain、text/css、text/html、application/javascript、application/json
    httpCode String
    返回的 HTTP 状态码。

    RuleRuleActionForwardGroupConfig, RuleRuleActionForwardGroupConfigArgs

    RuleRuleActionForwardGroupConfigServerGroupStickySession, RuleRuleActionForwardGroupConfigServerGroupStickySessionArgs

    Enabled string
    是否开启组间会话保持。on：开启。off：不开启。
    Timeout int
    组件回话保持的超时时间。单位：秒。
    Enabled string
    是否开启组间会话保持。on：开启。off：不开启。
    Timeout int
    组件回话保持的超时时间。单位：秒。
    enabled String
    是否开启组间会话保持。on：开启。off：不开启。
    timeout Integer
    组件回话保持的超时时间。单位：秒。
    enabled string
    是否开启组间会话保持。on：开启。off：不开启。
    timeout number
    组件回话保持的超时时间。单位：秒。
    enabled str
    是否开启组间会话保持。on：开启。off：不开启。
    timeout int
    组件回话保持的超时时间。单位：秒。
    enabled String
    是否开启组间会话保持。on：开启。off：不开启。
    timeout Number
    组件回话保持的超时时间。单位：秒。

    RuleRuleActionForwardGroupConfigServerGroupTuple, RuleRuleActionForwardGroupConfigServerGroupTupleArgs

    ServerGroupId string
    转发到的目的服务器组 ID。
    Weight int
    服务器组权重。
    ServerGroupId string
    转发到的目的服务器组 ID。
    Weight int
    服务器组权重。
    serverGroupId String
    转发到的目的服务器组 ID。
    weight Integer
    服务器组权重。
    serverGroupId string
    转发到的目的服务器组 ID。
    weight number
    服务器组权重。
    server_group_id str
    转发到的目的服务器组 ID。
    weight int
    服务器组权重。
    serverGroupId String
    转发到的目的服务器组 ID。
    weight Number
    服务器组权重。

    RuleRuleActionRedirectConfig, RuleRuleActionRedirectConfigArgs

    Host string
    重定向域名，仅支持精确域名。
    HttpCode string
    重定向状态码，支持301，302，307，308。
    Path string
    重定向 URI。。
    Port string
    重定向端口。
    Protocol string
    重定向使用的协议，支持HTTP，HTTPS。
    Host string
    重定向域名，仅支持精确域名。
    HttpCode string
    重定向状态码，支持301，302，307，308。
    Path string
    重定向 URI。。
    Port string
    重定向端口。
    Protocol string
    重定向使用的协议，支持HTTP，HTTPS。
    host String
    重定向域名，仅支持精确域名。
    httpCode String
    重定向状态码，支持301，302，307，308。
    path String
    重定向 URI。。
    port String
    重定向端口。
    protocol String
    重定向使用的协议，支持HTTP，HTTPS。
    host string
    重定向域名，仅支持精确域名。
    httpCode string
    重定向状态码，支持301，302，307，308。
    path string
    重定向 URI。。
    port string
    重定向端口。
    protocol string
    重定向使用的协议，支持HTTP，HTTPS。
    host str
    重定向域名，仅支持精确域名。
    http_code str
    重定向状态码，支持301，302，307，308。
    path str
    重定向 URI。。
    port str
    重定向端口。
    protocol str
    重定向使用的协议，支持HTTP，HTTPS。
    host String
    重定向域名，仅支持精确域名。
    httpCode String
    重定向状态码，支持301，302，307，308。
    path String
    重定向 URI。。
    port String
    重定向端口。
    protocol String
    重定向使用的协议，支持HTTP，HTTPS。

    RuleRuleActionRewriteConfig, RuleRuleActionRewriteConfigArgs

    Path string
    重写路径。
    Path string
    重写路径。
    path String
    重写路径。
    path string
    重写路径。
    path str
    重写路径。
    path String
    重写路径。

    RuleRuleActionTrafficLimitConfig, RuleRuleActionTrafficLimitConfigArgs

    Qps int
    每秒请求数。
    Qps int
    每秒请求数。
    qps Integer
    每秒请求数。
    qps number
    每秒请求数。
    qps int
    每秒请求数。
    qps Number
    每秒请求数。

    RuleRuleCondition, RuleRuleConditionArgs

    HeaderConfig Byteplus.RuleRuleConditionHeaderConfig
    HeaderConfig。
    HostConfig Byteplus.RuleRuleConditionHostConfig
    HostConfig。
    MethodConfig Byteplus.RuleRuleConditionMethodConfig
    MethodConfig。
    PathConfig Byteplus.RuleRuleConditionPathConfig
    PathConfig。
    QueryStringConfig Byteplus.RuleRuleConditionQueryStringConfig
    QueryStringConfig。
    Type string
    标准版转发规则条件类型。Host： 域名。Path： 路径。Header：HTTP头字段。Method: 请求方法。QueryString: 查询参数。
    HeaderConfig RuleRuleConditionHeaderConfig
    HeaderConfig。
    HostConfig RuleRuleConditionHostConfig
    HostConfig。
    MethodConfig RuleRuleConditionMethodConfig
    MethodConfig。
    PathConfig RuleRuleConditionPathConfig
    PathConfig。
    QueryStringConfig RuleRuleConditionQueryStringConfig
    QueryStringConfig。
    Type string
    标准版转发规则条件类型。Host： 域名。Path： 路径。Header：HTTP头字段。Method: 请求方法。QueryString: 查询参数。
    headerConfig RuleRuleConditionHeaderConfig
    HeaderConfig。
    hostConfig RuleRuleConditionHostConfig
    HostConfig。
    methodConfig RuleRuleConditionMethodConfig
    MethodConfig。
    pathConfig RuleRuleConditionPathConfig
    PathConfig。
    queryStringConfig RuleRuleConditionQueryStringConfig
    QueryStringConfig。
    type String
    标准版转发规则条件类型。Host： 域名。Path： 路径。Header：HTTP头字段。Method: 请求方法。QueryString: 查询参数。
    headerConfig RuleRuleConditionHeaderConfig
    HeaderConfig。
    hostConfig RuleRuleConditionHostConfig
    HostConfig。
    methodConfig RuleRuleConditionMethodConfig
    MethodConfig。
    pathConfig RuleRuleConditionPathConfig
    PathConfig。
    queryStringConfig RuleRuleConditionQueryStringConfig
    QueryStringConfig。
    type string
    标准版转发规则条件类型。Host： 域名。Path： 路径。Header：HTTP头字段。Method: 请求方法。QueryString: 查询参数。
    header_config RuleRuleConditionHeaderConfig
    HeaderConfig。
    host_config RuleRuleConditionHostConfig
    HostConfig。
    method_config RuleRuleConditionMethodConfig
    MethodConfig。
    path_config RuleRuleConditionPathConfig
    PathConfig。
    query_string_config RuleRuleConditionQueryStringConfig
    QueryStringConfig。
    type str
    标准版转发规则条件类型。Host： 域名。Path： 路径。Header：HTTP头字段。Method: 请求方法。QueryString: 查询参数。
    headerConfig Property Map
    HeaderConfig。
    hostConfig Property Map
    HostConfig。
    methodConfig Property Map
    MethodConfig。
    pathConfig Property Map
    PathConfig。
    queryStringConfig Property Map
    QueryStringConfig。
    type String
    标准版转发规则条件类型。Host： 域名。Path： 路径。Header：HTTP头字段。Method: 请求方法。QueryString: 查询参数。

    RuleRuleConditionHeaderConfig, RuleRuleConditionHeaderConfigArgs

    Key string
    头字段键。
    Values List<string>
    头字段值。
    Key string
    头字段键。
    Values []string
    头字段值。
    key String
    头字段键。
    values List<String>
    头字段值。
    key string
    头字段键。
    values string[]
    头字段值。
    key str
    头字段键。
    values Sequence[str]
    头字段值。
    key String
    头字段键。
    values List<String>
    头字段值。

    RuleRuleConditionHostConfig, RuleRuleConditionHostConfigArgs

    Values List<string>
    转发规则的域名，支持泛域名和精确域名。
    Values []string
    转发规则的域名，支持泛域名和精确域名。
    values List<String>
    转发规则的域名，支持泛域名和精确域名。
    values string[]
    转发规则的域名，支持泛域名和精确域名。
    values Sequence[str]
    转发规则的域名，支持泛域名和精确域名。
    values List<String>
    转发规则的域名，支持泛域名和精确域名。

    RuleRuleConditionMethodConfig, RuleRuleConditionMethodConfigArgs

    Values List<string>
    请求方法。支持HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。
    Values []string
    请求方法。支持HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。
    values List<String>
    请求方法。支持HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。
    values string[]
    请求方法。支持HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。
    values Sequence[str]
    请求方法。支持HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。
    values List<String>
    请求方法。支持HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。

    RuleRuleConditionPathConfig, RuleRuleConditionPathConfigArgs

    Values List<string>
    转发规则的URL，仅支持绝对路径。
    Values []string
    转发规则的URL，仅支持绝对路径。
    values List<String>
    转发规则的URL，仅支持绝对路径。
    values string[]
    转发规则的URL，仅支持绝对路径。
    values Sequence[str]
    转发规则的URL，仅支持绝对路径。
    values List<String>
    转发规则的URL，仅支持绝对路径。

    RuleRuleConditionQueryStringConfig, RuleRuleConditionQueryStringConfigArgs

    RuleRuleConditionQueryStringConfigValue, RuleRuleConditionQueryStringConfigValueArgs

    Key string
    查询字符串键。
    Value string
    查询字符串值。
    Key string
    查询字符串键。
    Value string
    查询字符串值。
    key String
    查询字符串键。
    value String
    查询字符串值。
    key string
    查询字符串键。
    value string
    查询字符串值。
    key str
    查询字符串键。
    value str
    查询字符串值。
    key String
    查询字符串键。
    value String
    查询字符串值。

    Import

    $ pulumi import bytepluscc:alb/rule:Rule example "listener_id|rule_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.