|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "volcenginecc_alb_rule Data Source - terraform-provider-volcenginecc" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + Data Source schema for Volcengine::ALB::Rule |
| 7 | +--- |
| 8 | + |
| 9 | +# volcenginecc_alb_rule (Data Source) |
| 10 | + |
| 11 | +Data Source schema for Volcengine::ALB::Rule |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +<!-- schema generated by tfplugindocs --> |
| 16 | +## Schema |
| 17 | + |
| 18 | +### Required |
| 19 | + |
| 20 | +- `id` (String) Uniquely identifies the resource. |
| 21 | + |
| 22 | +### Read-Only |
| 23 | + |
| 24 | +- `description` (String) 转发规则的描述。 |
| 25 | +- `domain` (String) 转发规则的域名。 |
| 26 | +- `forward_group_config` (Attributes) 转发规则服务器组配置 (see [below for nested schema](#nestedatt--forward_group_config)) |
| 27 | +- `listener_id` (String) 监听器ID。 |
| 28 | +- `priority` (Number) 标准版转发规则优先级。 |
| 29 | +- `redirect_config` (Attributes) 重定向相关配置信息。 (see [below for nested schema](#nestedatt--redirect_config)) |
| 30 | +- `rewrite_config` (Attributes) 重定向相关配置信息。 (see [below for nested schema](#nestedatt--rewrite_config)) |
| 31 | +- `rewrite_enabled` (String) 转发规则重写配置开关。on:开启。off:关闭。 |
| 32 | +- `rule_action` (String) 转发规则动作。空:默认转发至服务器组。Redirect:重定向。 |
| 33 | +- `rule_actions` (Attributes List) 标准版转发规则动作。 (see [below for nested schema](#nestedatt--rule_actions)) |
| 34 | +- `rule_conditions` (Attributes Set) 标准版转发规则条件。 (see [below for nested schema](#nestedatt--rule_conditions)) |
| 35 | +- `rule_id` (String) 转发规则ID。 |
| 36 | +- `server_group_id` (String) 转发规则关联的后端服务器组ID。 |
| 37 | +- `traffic_limit_enabled` (String) 转发规则 QPS 限速开关。on:开启。off:关闭。 |
| 38 | +- `traffic_limit_qps` (Number) 每秒请求数。取值范围:100~100000。 |
| 39 | +- `url` (String) 转发规则的URL。 |
| 40 | + |
| 41 | +<a id="nestedatt--forward_group_config"></a> |
| 42 | +### Nested Schema for `forward_group_config` |
| 43 | + |
| 44 | +Read-Only: |
| 45 | + |
| 46 | +- `server_group_tuples` (Attributes Set) 转发到的目的服务器组列表。 (see [below for nested schema](#nestedatt--forward_group_config--server_group_tuples)) |
| 47 | +- `sticky_session_enabled` (String) 是否开启组间会话保持。on:开启。off:不开启。 |
| 48 | +- `sticky_session_timeout` (Number) 组件回话保持的超时时间。单位:秒。 |
| 49 | + |
| 50 | +<a id="nestedatt--forward_group_config--server_group_tuples"></a> |
| 51 | +### Nested Schema for `forward_group_config.server_group_tuples` |
| 52 | + |
| 53 | +Read-Only: |
| 54 | + |
| 55 | +- `server_group_id` (String) 转发到的目的服务器组 ID。 |
| 56 | +- `weight` (Number) 服务器组权重。 |
| 57 | + |
| 58 | + |
| 59 | + |
| 60 | +<a id="nestedatt--redirect_config"></a> |
| 61 | +### Nested Schema for `redirect_config` |
| 62 | + |
| 63 | +Read-Only: |
| 64 | + |
| 65 | +- `redirect_domain` (String) 重定向的域名。若创建/修改重定向类型的转发规则时,重定向域名设置为空,接口会返回${host},该变量含义为重定向域名与请求域名保持一致,但不支持创建/修改时,将重定向域名设置为${host}.。 |
| 66 | +- `redirect_http_code` (String) 重定向状态码。301、302、307、308。 |
| 67 | +- `redirect_port` (String) 重定向的端口。若创建/修改重定向类型的转发规则时,重定向端口设置为空,接口会返回${port},该变量含义为重定向端口与请求端口(监听器端口)保持一致,但不支持创建/修改时,将重定向端口设置为${port}.。 |
| 68 | +- `redirect_protocol` (String) 重定向使用的协议。HTTP、HTTPS。 |
| 69 | +- `redirect_uri` (String) 重定向的URI。若创建/修改重定向类型的转发规则时,重定向uri设置为空,接口会返回${request_uri},该变量含义为重定向uri与请求uri保持一致,但不支持创建/修改时,将重定向uri设置为${request_uri}.。 |
| 70 | + |
| 71 | + |
| 72 | +<a id="nestedatt--rewrite_config"></a> |
| 73 | +### Nested Schema for `rewrite_config` |
| 74 | + |
| 75 | +Read-Only: |
| 76 | + |
| 77 | +- `rewrite_path` (String) 重写路径。 |
| 78 | + |
| 79 | + |
| 80 | +<a id="nestedatt--rule_actions"></a> |
| 81 | +### Nested Schema for `rule_actions` |
| 82 | + |
| 83 | +Read-Only: |
| 84 | + |
| 85 | +- `fixed_response_config` (Attributes) FixedResponseConfig (see [below for nested schema](#nestedatt--rule_actions--fixed_response_config)) |
| 86 | +- `forward_group_config` (Attributes) ForwardGroupConfig (see [below for nested schema](#nestedatt--rule_actions--forward_group_config)) |
| 87 | +- `redirect_config` (Attributes) RedirectConfig (see [below for nested schema](#nestedatt--rule_actions--redirect_config)) |
| 88 | +- `rewrite_config` (Attributes) RewriteConfig (see [below for nested schema](#nestedatt--rule_actions--rewrite_config)) |
| 89 | +- `traffic_limit_config` (Attributes) TrafficLimitConfig (see [below for nested schema](#nestedatt--rule_actions--traffic_limit_config)) |
| 90 | +- `type` (String) 转发规则动作类型。ForwardGroup:转发至多个虚拟服务器组。Redirect: 重定向。Rewrite: 重写。TrafficLimit:流量限速。 |
| 91 | + |
| 92 | +<a id="nestedatt--rule_actions--fixed_response_config"></a> |
| 93 | +### Nested Schema for `rule_actions.fixed_response_config` |
| 94 | + |
| 95 | +Read-Only: |
| 96 | + |
| 97 | +- `content` (String) 返回的固定内容。 |
| 98 | +- `content_type` (String) 返回的固定内容的格式。text/plain、text/css、text/html、application/javascript、application/json |
| 99 | +- `http_code` (String) 返回的 HTTP 状态码。 |
| 100 | + |
| 101 | + |
| 102 | +<a id="nestedatt--rule_actions--forward_group_config"></a> |
| 103 | +### Nested Schema for `rule_actions.forward_group_config` |
| 104 | + |
| 105 | +Read-Only: |
| 106 | + |
| 107 | +- `server_group_sticky_session` (Attributes) ServerGroupStickySession (see [below for nested schema](#nestedatt--rule_actions--forward_group_config--server_group_sticky_session)) |
| 108 | +- `server_group_tuples` (Attributes Set) ServerGroupTuples (see [below for nested schema](#nestedatt--rule_actions--forward_group_config--server_group_tuples)) |
| 109 | + |
| 110 | +<a id="nestedatt--rule_actions--forward_group_config--server_group_sticky_session"></a> |
| 111 | +### Nested Schema for `rule_actions.forward_group_config.server_group_sticky_session` |
| 112 | + |
| 113 | +Read-Only: |
| 114 | + |
| 115 | +- `enabled` (String) 是否开启组间会话保持。on:开启。off:不开启。 |
| 116 | +- `timeout` (Number) 组件回话保持的超时时间。单位:秒。 |
| 117 | + |
| 118 | + |
| 119 | +<a id="nestedatt--rule_actions--forward_group_config--server_group_tuples"></a> |
| 120 | +### Nested Schema for `rule_actions.forward_group_config.server_group_tuples` |
| 121 | + |
| 122 | +Read-Only: |
| 123 | + |
| 124 | +- `server_group_id` (String) 转发到的目的服务器组 ID。 |
| 125 | +- `weight` (Number) 服务器组权重。 |
| 126 | + |
| 127 | + |
| 128 | + |
| 129 | +<a id="nestedatt--rule_actions--redirect_config"></a> |
| 130 | +### Nested Schema for `rule_actions.redirect_config` |
| 131 | + |
| 132 | +Read-Only: |
| 133 | + |
| 134 | +- `host` (String) 重定向域名,仅支持精确域名。 |
| 135 | +- `http_code` (String) 重定向状态码,支持301,302,307,308。 |
| 136 | +- `path` (String) 重定向 URI。。 |
| 137 | +- `port` (String) 重定向端口。 |
| 138 | +- `protocol` (String) 重定向使用的协议,支持HTTP,HTTPS。 |
| 139 | + |
| 140 | + |
| 141 | +<a id="nestedatt--rule_actions--rewrite_config"></a> |
| 142 | +### Nested Schema for `rule_actions.rewrite_config` |
| 143 | + |
| 144 | +Read-Only: |
| 145 | + |
| 146 | +- `path` (String) 重写路径。 |
| 147 | + |
| 148 | + |
| 149 | +<a id="nestedatt--rule_actions--traffic_limit_config"></a> |
| 150 | +### Nested Schema for `rule_actions.traffic_limit_config` |
| 151 | + |
| 152 | +Read-Only: |
| 153 | + |
| 154 | +- `qps` (Number) 每秒请求数。 |
| 155 | + |
| 156 | + |
| 157 | + |
| 158 | +<a id="nestedatt--rule_conditions"></a> |
| 159 | +### Nested Schema for `rule_conditions` |
| 160 | + |
| 161 | +Read-Only: |
| 162 | + |
| 163 | +- `header_config` (Attributes) HeaderConfig。 (see [below for nested schema](#nestedatt--rule_conditions--header_config)) |
| 164 | +- `host_config` (Attributes) HostConfig。 (see [below for nested schema](#nestedatt--rule_conditions--host_config)) |
| 165 | +- `method_config` (Attributes) MethodConfig。 (see [below for nested schema](#nestedatt--rule_conditions--method_config)) |
| 166 | +- `path_config` (Attributes) PathConfig。 (see [below for nested schema](#nestedatt--rule_conditions--path_config)) |
| 167 | +- `query_string_config` (Attributes) QueryStringConfig。 (see [below for nested schema](#nestedatt--rule_conditions--query_string_config)) |
| 168 | +- `type` (String) 标准版转发规则条件类型。Host: 域名。Path: 路径。Header:HTTP头字段。Method: 请求方法。QueryString: 查询参数。 |
| 169 | + |
| 170 | +<a id="nestedatt--rule_conditions--header_config"></a> |
| 171 | +### Nested Schema for `rule_conditions.header_config` |
| 172 | + |
| 173 | +Read-Only: |
| 174 | + |
| 175 | +- `key` (String) 头字段键。 |
| 176 | +- `values` (Set of String) 头字段值。 |
| 177 | + |
| 178 | + |
| 179 | +<a id="nestedatt--rule_conditions--host_config"></a> |
| 180 | +### Nested Schema for `rule_conditions.host_config` |
| 181 | + |
| 182 | +Read-Only: |
| 183 | + |
| 184 | +- `values` (Set of String) 转发规则的域名,支持泛域名和精确域名。 |
| 185 | + |
| 186 | + |
| 187 | +<a id="nestedatt--rule_conditions--method_config"></a> |
| 188 | +### Nested Schema for `rule_conditions.method_config` |
| 189 | + |
| 190 | +Read-Only: |
| 191 | + |
| 192 | +- `values` (Set of String) 请求方法。支持HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。 |
| 193 | + |
| 194 | + |
| 195 | +<a id="nestedatt--rule_conditions--path_config"></a> |
| 196 | +### Nested Schema for `rule_conditions.path_config` |
| 197 | + |
| 198 | +Read-Only: |
| 199 | + |
| 200 | +- `values` (Set of String) 转发规则的URL,仅支持绝对路径。 |
| 201 | + |
| 202 | + |
| 203 | +<a id="nestedatt--rule_conditions--query_string_config"></a> |
| 204 | +### Nested Schema for `rule_conditions.query_string_config` |
| 205 | + |
| 206 | +Read-Only: |
| 207 | + |
| 208 | +- `values` (Attributes Set) Values。 (see [below for nested schema](#nestedatt--rule_conditions--query_string_config--values)) |
| 209 | + |
| 210 | +<a id="nestedatt--rule_conditions--query_string_config--values"></a> |
| 211 | +### Nested Schema for `rule_conditions.query_string_config.values` |
| 212 | + |
| 213 | +Read-Only: |
| 214 | + |
| 215 | +- `key` (String) 查询字符串键。 |
| 216 | +- `value` (String) 查询字符串值。 |
0 commit comments