负载均衡
负载均衡
应用型负载均衡ALB
请输入
- 文档首页
负载均衡API 参考转发规则CreateRules - 为监听器添加转发规则
复制全文
下载 pdfCreateRules - 为监听器添加转发规则
文档反馈
问问助手调用 CreateRules 接口，为监听器添加转发规则，将来自不同域名、URL的访问请求转发到不同的服务器组。
使用说明
- 每秒最多提交5个API请求。
- 本API适用于基础版ALB和标准版ALB：
- 若参数注明基础版，则该参数为基础版ALB独有。
- 若参数注明标准版，则该参数为标准版ALB独有。
- 若参数未标注，则为基础版ALB和标准版ALB共有。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：CreateRules
要执行的操作，取值：CreateRules。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
Rules.N.RuleActions.N.RewriteConfig.Host string[] 可选 示例值：Rules.1.RuleActions.1.RewriteConfig.Host=www.test.com
（标准版）重写后的域名。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。取值范围：1 ～ 10。
- 不填默认与原请求域名一致。
- 指定的域名须满足以下要求：
- 主机名长度为 3~128 个字符，支持小写字母 a ~ z、数字、短划线（-）、半角句号（.）以及通配符星号（*）、等号（=）、波浪线（ ~ ）、下划线（_）、加号（+）、反斜线（\）、脱字号（^）、感叹号（!）、美元符号（$）、and（&）、竖线（|）、半角圆括号（()）、方括号（[]）和半角问号（?）。
- 主机名至少包含一个半角句号（.），且半角句号（.）不能出现在开头或结尾。
- 最右侧的域标签只能包含字母和通配符，不能包含数字或短划线（-），最左侧的域标签允许是星号（*）。
- 短划线（-）不能出现在其它域标签的开头或结尾。通配符星号（*）和半角问号（？）可以出现在域标签的任意位置。
Rules.N.RuleConditions.N.CookieConfig.Values.N.Key string[] 可选 示例值：Rules.1.RuleConditions.1.CookieConfig.Values.1.Key=aaa
（标准版）Cookie 键。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。取值范围：1 ～ 10。
- 第三个N：表示 Cookie 的序号。取值范围为1 ～ 10。
- Cookie 键不能为空。
- 支持 1~100 个字符。
- 支持可见字符和通配符星号（*）和半角问号（?），如果是字母必须为小写字母。
- 不支持空格和;#\[\]{}\\|<>&"。
- 不能全由*和？组成。
Rules.N.RuleActions.N.CorsConfig.AllowHeaders.N string[] 可选 示例值：Rules.1.RuleActions.1.CorsConfig.AllowHeaders.1=abc
（标准版）允许跨域的 Header。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。取值范围：1 ～ 10。
- 第三个N：表示跨域的 Header的序号。取值范围为1 ～ 10。
- 支持配置为*或配置一个或多个 value 值，多个 value 值用半角逗号（,）隔开。
- 单个 value 值只允许包含大小写字母、数字，以及不在首尾的下划线（_）和短划线（-），最大长度限制为 32 个字符。
Rules.N.RuleActions.N.CorsConfig.AllowMethods.N string[] 可选 示例值：Rules.1.RuleActions.1.CorsConfig.AllowMethods.1=GET
（标准版）选择跨域访问时允许的 HTTP 方法。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。取值范围：1 ～ 10。
- 第三个N：表示跨域访问时允许的 HTTP 方法的序号。取值范围为1 ～ 10。
- 支持取值：GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH。
Rules.N.RuleConditions.N.SourceIpConfig.Values.N string[] 可选 示例值：Rules.1.RuleConditions.1.SourceIpConfig.Values.1=192.168.1.0/24
（标准版）SourceIP白名单。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。取值范围：1 ～ 10。
- 第三个N：表示SourceIP的序号。取值范围为1 ～ 10。
- 仅支持输入IPv4地址/IPv4地址段，且IP地址必须带掩码。
- 不支持0.0.0.0/x类型的地址段，x为任意数字。
- 转发条件中包含SourceIP，只有请求来源匹配到SourceIP地址段或地址的请求才能匹配到该规则。
- 一条规则SourceIP类型条件最多支持5个值。
Rules.N.RuleConditions.N.CookieConfig.Values.N.Value string[] 可选 示例值：Rules.1.RuleConditions.1.CookieConfig.Values.1.Value=test
（标准版）Cookie 值。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。取值范围：1 ～ 10。
- 第三个N：表示Cookie的序号。取值范围为1 ～ 10。
- Cookie 值不能为空。
- 支持 1~100个字符。
- 支持可见字符和通配符星号（*）和半角问号（?），如果是字母必须为小写字母。
- 不支持空格和;#\[\]{}\\|<>&"。
- 不能全由*和？组成。
Rules.N.RuleActions.N.CorsConfig.AllowOrigin.N string[] 可选 示例值：Rules.1.RuleActions.1.CorsConfig.AllowOrigin.1=http://www.test.com
（标准版）设置允许通过浏览器访问服务器资源的站点。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。取值范围：1 ～ 10。
- 第三个N：表示站点的序号。取值范围为1 ～ 10。
- 支持配置通配符“*”，也允许配置多个值，以逗号分隔，最多设置32个值。
- 每个值必须以http://或者https://开头，后跟一个域名或者一级的泛域名(*.test.abc.example.com)。
- 每个值支持设置端口，端口范围 1~65535。
Rules.N.RuleActions.N.CorsConfig.ExposeHeaders.N string[] 可选 示例值：Rules.1.RuleActions.1.CorsConfig.ExposeHeaders.1=abc
（标准版）允许浏览器、JavaScript脚本访问的响应头部。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。取值范围：1 ～ 10。
- 第三个N：表示响应头部的序号。取值范围为1 ～ 10。
- 可以配置通配符“*”，也允许配置多个值，以逗号分隔，最多设置32个值。
- 每个值只允许大小写字母、数字以及不在首尾的"-"和"_"，最长32个字符。
Rules.N.RuleActions.N.CorsConfig.AllowCredentials string[] 可选 示例值：Rules.1.RuleActions.1.CorsConfig.AllowCredentials=on
（标准版）是否允许携带凭证信息。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。取值范围：1 ～ 10。
- 取值如下：
- on：是。
- off（默认值）：否。
Rules.N.RuleActions.N.CorsConfig.MaxAge integer[] 可选 示例值：Rules.1.RuleActions.1.CorsConfig.MaxAge=600
（标准版）预检请求在浏览器的最大缓存时间，单位：秒。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。取值范围：1 ～ 10。
- 取值范围：-1～172800。
- -1和0表示不缓存。
Rules.N.RuleActions.N.RedirectConfig.Query string[] 可选 示例值：Rules.1.RuleActions.1.RedirectConfig.Query=test
（标准版）重定向到的查询字符串。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号。 取值范围：1~5。
- 指定的查询字符串须满足以下要求：
- 最多允许 128 个字符。
- 不支持空格和 #[]{}|<>"。如果是字母则必须是小写字母。
- 如果您不指定查询字符串，重定向到的查询字符串与请求的查询字符串相同。
Rules.N.RuleActions.N.InsertHeaderConfig.Value string[] 可选 示例值：$remote_addr
（标准版）写入Header的字段内容。
- 字段内容的类型为 SystemDefined时，取值如下：
- $remote_addr：客户端端口。
- $remote_port：客户端 IP 地址。
- $scheme：客户端请求的协议（HTTP 或 HTTPS)。
- $load_balancer_id：应用型负载均衡实例 ID。
- $vport：应用型负载均衡实例监听端口。
- $endpoint_id：终端节点ID。
说明
$endpoint_id正在邀测中，如需试用，请联系客户经理。
- 字段内容的类型为 UserDefined 时，可自定义头字段内容。
- 限制长度为 1~128 个字符。
- 支持通配符星号（*）、半角问号（?）和 ASCII 码值ch >= 32 && ch < 127范围内的可打印字符，不支持$，不支持"。
- 开头和结尾不能为空格。
- 结尾不能为\。
Rules.N.RuleActions.N.InsertHeaderConfig.ValueType string[] 可选 示例值：SystemDefined
（标准版）写入Header的字段内容的类型。取值如下：
- UserDefined：自定义头字段内容。
- SystemDefined：系统定义头字段内容。
Rules.N.RuleActions.N.InsertHeaderConfig.Key string[] 可选 示例值：remote-addr
（标准版）写入Header的字段名称。
- 长度限制为 1~40 个字符。
- 支持大小写字母 a~z、数字、下划线（_）和短划线（-）。
- 字段名称不能重复。
- 无论大写还是小写，不支持传入： x-real-ip，x-forwarded-for，x-forwarded-proto，x-alb-waf-requestid，x-alb-waf-real-port，upgrade，connection，x-vport，x-vip，x-clb-cluster，x-toutiao-lb-ip，x-vni，content-length，transfer-encoding，keep-alive，host，cookie，authority。
Rules.N.Description string[] 可选 示例值：--
转发规则的描述。
- 参数- N：表示转发规则的序号，取值范围为1 ～ 20。
- 多个转发规则间使用“&”分隔。
- 具体规范如下：
- 不填默认为空字符串。
- 不能超过 255 个字符。
- 必须以英文字母或汉字开头。
- 只能包含英文字母、汉字、数字、空格和以下特殊字符,.\_=-，。。
Rules.N.Url string[] 可选 示例值：/
（基础版）转发规则的Url。
- 参数- N：表示转发规则的序号，取值范围为1 ～ 20。
- 仅支持绝对路径。ALB 允许您指定精确路径或使用正则表达式来指定路径。ALB使用正则表达式正在邀侧中，如需试用，请联系客户经理。
- 指定的路径须满足以下要求：
- 精确路径：
- 必须以正斜线（/）开头。
- 只能包含英文字母、数字和以下特殊字符：- _ / . % ? # &＝。正斜线（/）不能连用。
- 最多允许 128 个字符。
- 正则表达式：
- 必须以波浪号（ ~ ）开头，且波浪号（ ~ ）只能出现一次。
- 仅允许包含英文字母、数字和以下特殊字符：.- _ / ＝ ? ~ ^ * $ : ( ) [ ] + | 。
- ~ 开头表示区分大小写。~ *开头表示不区分大小写。
- 最多允许 128 个字符。
说明
- Rules.N.Domain 和 Rules.N.Url 两者至少须指定一个，且 Rules.N.Domain 和 Rules.N.Url 参数值的组合在同一个监听器下必须唯一。
- 若您指定 Rules.N.Domain 参数，未指定 Rules.N.Url 参数，Rules.N.Url 参数会采用默认值 /，代表根目录。
- 若您未指定 Rules.N.Domain，Rules.N.Url 的值不能设置为 /。
Rules.N.RuleAction string[] 可选 示例值：Rules.1.RuleAction=''&Rules.2.RuleAction=Redirect
（基础版）转发动作。取值如下：
- 参数- N：表示转发规则的序号，取值范围为1 ～ 20。
- 空值（默认值）：转发至。ALB 将请求转发至您指定的后端服务器组。
- Redirect：重定向。ALB 对请求进行重定向。
Rules.N.RewriteEnabled string[] 可选 示例值：on
（基础版）是否开启“重写”功能。
- 参数- N：表示转发规则的序号，取值范围为1 ～ 20。
- 取值如下：
- on：开启。
- off（默认值）：关闭。
说明
- 仅当 Rules.N.RuleAction 值为空（即转发动作为“转发至”）时，允许配置该参数。否则，参数值不生效。
- 转发规则重写功能正在邀测中，如需试用，请联系客户经理。
Rules.N.RewriteConfig.RewritePath string[] 可选 示例值：Rules.1.RewriteConfig.RewritePath=/{1}/${2}&Rules.2.RewriteConfig.RewritePath=/poo
（基础版）重写路径。
- 参数 - N：表示域名的序号，取值范围 1~20。
- 多个域名间使用“&”分隔。
- 具体规范如下：
- 必须以正斜线“/”开头。
- 仅允许包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’等字符。
- 长度限制为1 ～ 128个字符。
- 支持正则表达式替换，重写路径中需要包含${1}、${2}、${3}中的一个或多个，且这三个变量不支持使用其余字符代替。
Rules.N.RedirectConfig.RedirectProtocol string[] 可选 示例值：Rules.1.RedirectConfig.RedirectProtocol=HTTP&Rules.2.RedirectConfig.RedirectProtocol=HTTPS
（基础版）重定向使用的协议。
- 参数-N：表示域名的序号，取值范围 1~20。
- 多个域名间使用“&”分隔。
- 取值如下：
- HTTP
- HTTPS（默认）。
- 当转发规则动作为Redirect，即重定向时，若该参数不指定，则默认赋值为 HTTPS 。
Rules.N.RedirectConfig.RedirectHttpCode string[] 可选 示例值：Rules.1.RedirectConfig.RedirectHttpCode=301&Rules.2.RedirectConfig.RedirectHttpCode=302
（基础版）重定向状态码。
- 参数-N：表示域名的序号，取值范围 1~20。
- 多个域名间使用“&”分隔。
- 取值如下：
- 301（默认）
- 302
- 307
- 308
- 当转发规则动作为Redirect，即重定向时，若该参数不指定，则默认赋值301。
Rules.N.RedirectConfig.RedirectUri string[] 可选 示例值：Rules.1.RedirectConfig.RedirectUri=/&Rules.2.RedirectConfig.RedirectUri=/poo
（基础版）重定向URI。
- 参数 - N：表示域名的序号，取值范围 1~20。
- 多个域名间使用“&”分隔。
- 具体规范如下：
- 必须以正斜线“/”开头。
- 仅允许包含字母、数字、‘-’、‘_’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’、‘＝’等字符。
- 长度限制为1 ～ 128个字符。
- 当转发规则动作为 Redirect，即重定向时，若该参数不指定，会被赋值为默认值（空），最终效果为与请求URI保持一致。
Rules.N.TrafficLimitEnabled string[] 可选 示例值：on
（基础版）转发规则QPS限速开关。
- 参数- N：表示转发规则的序号，取值范围为1 ～ 20。
- 取值如下：
- on：开启。
- off：关闭（默认）。
Rules.N.TrafficLimitQPS integer[] 可选 示例值：100
（基础版）QPS限速值。
- 参数- N：表示转发规则的序号，取值范围为1 ～ 20。
- 当 Rules.N.TrafficLimitEnabled 为 on 时，本字段必选。
- 表示每秒请求数。取值范围：100～100000。
Rules.N.RedirectConfig.RedirectDomain string[] 可选 示例值：Rules.1.RedirectConfig.RedirectDomain=*.com&Rules.2.RedirectConfig.RedirectDomain=[www.test.com](http://www.test.com)
（基础版）重定向域名。
- 参数-N：表示域名的序号，取值范围 1~20。
- 多个域名间使用“&”分隔。
- 仅支持精确域名。
- 具体规范如下：
- 需至少包含一个‘.’，且不允许以‘.’开头或结尾。
- 仅允许包含字母、数字、‘.’、‘-‘。
- 长度限制为1 ～ 128个字符。
- 精确域名：符合域名规范的精确域名，例如：www.test.com。
- 当转发规则动作为 Redirect，即重定向时，若该参数不指定，会被赋值为默认值（空），最终效果为与请求域名保持一致。
Rules.N.RedirectConfig.RedirectPort string[] 可选 示例值：Rules.1.RedirectConfig.RedirectPort=80&Rules.2.RedirectConfig.RedirectPort=443
（基础版）重定向端口。
- 参数- N：表示域名的序号，取值范围 1~20。
- 多个域名间使用“&”分隔。
- 取值范围：1～65535。
- 当转发规则动作为Redirect，即重定向时，若该参数不指定，否则将赋值为默认值（空），最终效果为与请求端口保持一致。
Rules.N.Domain string[] 可选 示例值：Rules.1.Domain=*.com&Rules.2.Domain=www.test.com
（基础版）转发条件中的域名。
- 参数- N：表示转发规则的序号，取值范围为1 ～ 20。
- 基本输入规范：
- 只能包含英文字母、数字和以下特殊字符：. - _ *。
- 须至少包含一个半角句号（.），但不能以半角句号（.）作为开头和结尾。
- 最多允许 128 个字符。
- 域名大小写不敏感。
- 域名类型：
- 精确域名：须符合域名规范。
- 泛域名
- 星号（*）可以代替 1 个或多个字符。
- 星号（*）必须在域名开头或结尾。
- 一个域名中最多只能包含一个星号（*）。
- 星号（*）前后不能有除了半角句号（.）以外的字符。
- 域名示例：
- 合法域名示例：www.test.com、*.com、www.test.*。
- 非法域名示例： *aaa.com、www.*.com。
- 注意事项：
- Rules.N.Domain 和 Rules.N.Url 两者至少需指定一个，且 Rules.N.Domain 和 Rules.N.Url 参数值的组合在同一个监听器下必须唯一。
- 若您指定 Rules.N.Url 参数，未指定 Rules.N.Domain 参数，Rules.N.Domain 参数会采用默认值 - ，代表任意域名。
Rules.N.ForwardGroupConfig.StickySessionTimeout integer[] 可选 示例值：Rules.1.ForwardGroupConfig.StickySessionTimeout=5000
（基础版）组件会话保持的超时时间。单位：秒。
- 参数- N：表示转发规则的序号，取值范围为1 ～ 20。
- 取值范围：1 ~ 86400 。
- 默认值：1000 。
Rules.N.ForwardGroupConfig.StickySessionEnabled string[] 可选 示例值：Rules.1.ForwardGroupConfig.StickySessionEnabled=on
（基础版）是否开启组间会话保持。
- 参数- N：表示转发规则的序号，取值范围为1 ～ 20。
- 取值如下：
- on：开启。
- off（默认值）：不开启。
Rules.N.ForwardGroupConfig.ServerGroupTuples.N.Weight integer[] 可选 示例值：Rules.1.ForwardGroupConfig.ServerGroupTuples.2.Weight=50
（基础版）转发到对应后端服务器组的权重。
- 取值范围：0~100。
- 如果服务器组数量为1，且未指定此参数时，将默认为100。
- 第一个N：表示转发规则的序号，取值范围为1 ～ 20。
- 第二个N：表示转发到服务器组的序号，取值范围为1 ～ 5。
Rules.N.ForwardGroupConfig.ServerGroupTuples.N.ServerGroupId string[] 可选 示例值：Rules.1.ForwardGroupConfig.ServerGroupTuples.2.ServerGroupId=rsp-j7vhgiusf98adf
（基础版）转发到后端服务器组的ID。
- 第一个N：表示转发规则的序号，取值范围为1 ～ 20。当转发规则动作为空，即转发至服务器组，此参数和Rules.N.ServerGroupId必须选择填一项，且此参数的优先级高于Rules.N.ServerGroupId，此参数如果非空的情况下会忽略Rules.N.ServerGroupId。
- 第二个N：表示转发到服务器组的序号，取值范围为1 ～ 5。
Rules.N.RuleActions.N.FixedResponseConfig.Content string[] 可选 示例值：Rules.1.RuleActions.1.RewriteConfig.Content=response_ok
（标准版）转发规则返回的固定内容。
- 第一个N：表示转发规则的序号，取值范围为1 ～ 20。
- 第二个N：表示转发动作的序号，取值范围为1 ～ 5。
- 最长1024个字符。
- 只支持 utf-8字符。
Rules.N.RuleActions.N.FixedResponseConfig.ContentType string[] 可选 示例值：Rules.1.RuleActions.1.FixedResponseConfig.ContentType=text/plain
（标准版）转发规则返回固定内容的格式。
- 第一个N：表示转发规则的序号，取值范围为1 ～ 20。
- 第二个N：表示转发动作的序号，取值范围为1 ～ 5。
- 取值如下：
- text/plain
- text/css
- text/html
- application/javascript
- application/json。
Rules.N.RuleActions.N.FixedResponseConfig.HttpCode string[] 可选 示例值：Rules.1.RuleActions.1.FixedResponseConfig.HttpCode=200
（标准版）转发规则返回的HTTP响应码。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发条件的序号。取值范围：1~10。
- 仅支持 2xx、4xx、5xx 数字型字符串，x 为任意数字。
Rules.N.RuleConditions.N.MethodConfig.Values.N string[] 可选 示例值：Rules.1.RuleConditions.1.MethodConfig.Values.1=GET
（标准版）转发条件的请求方法。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发条件的序号。取值范围：1~10。
- 第三个N：表示键的序号。取值范围：1~10。
- 取值：HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。
Rules.N.RuleConditions.N.QueryStringConfig.Values.N.Key string[] 可选 示例值：Rules.1.RuleConditions.1.QueryStringConfig.Values.1.Key=version
（标准版）转发条件的查询字符串键。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发条件的序号。取值范围：1~10。
- 第三个N：表示查询字符串键的序号。取值范围：1~10。
- 长度为 1~100 个字符。
- 支持可见字符、通配符星号（*）和半角问号（？），如果是字母则必须为小写字母。不支持空格和#[]{}\|<>&"。
Rules.N.RuleConditions.N.QueryStringConfig.Values.N.Value string[] 可选 示例值：Rules.1.RuleConditions.1.QueryStringConfig.Values.1.Value=1.0.
（标准版）转发条件的查询字符串值。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发条件的序号。取值范围：1~10。
- 第三个N：表示查询字符串值的序号。取值范围：1~10。
- 长度为 1~128 个字符。
- 支持小写字母、可见字符和通配符星号（*）和半角问号（？），不支持空格和#[]{}\|<>&"。
Rules.N.Priority integer[] 可选 示例值：Rules.1.Priority=1&Rules.2.Priority=2
（标准版）转发规则优先级。
参数-N：表示转发规则的序号，取值范围为1 ～ 20。
Rules.N.RuleConditions.N.Type string[] 可选 示例值：Rules.1.RuleConditions.1.Type=Host
（标准版）转发条件的类型。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发条件的序号。取值范围：1～10。
- 转发条件类型的取值范围：
- Host：域名。
- Path：路径。
- Header：HTTP 标头。
- 各转发条件可以单独配置，也可以组合配置。当多个转发条件组合配置时，这些转发条件之间是“且”的关系。
- 同一转发条件下可以配置多个值，这些值之间是“或”的关系。
Rules.N.RuleConditions.N.HostConfig.Values.N string[] 可选 示例值：Rules.1.RuleConditions.1.HostConfig.Values.1=www.test.com
（标准版）转发条件的域名。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发条件的序号。取值范围：1~10。
- 第三个N：表示域名的序号。取值范围：1~10。
- 多个域名之间使用 & 符号分隔。当您指定多个域名时，这些域名之间是“或”的关系。
- 基本输入规范：
- 只能包含英文字母、数字和以下特殊字符. - _ *。
- 须至少包含一个半角句号（.），但不能以半角句号（.）作为开头和结尾。
- 最多允许 128 个字符。
- 域名大小写不敏感。
- 域名类型：
- 精确域名：须符合域名规范。
- 泛域名：
- 星号（*）可以代替 1 个或多个字符。
- 星号（*）必须在域名开头或结尾。
- 一个域名中最多只能包含一个星号（*）。
- 星号（*）前后不能有除了半角句号（.）以外的字符。
- 域名示例：
- 合法域名示例：www.test.com、.com、www.test.。
- 非法域名示例： aaa.com、www..com。
Rules.N.RuleConditions.N.PathConfig.Values.N string[] 可选 示例值：Rules.1.RuleConditions.1.PathConfig.Values.1=/foo
（标准版）转发条件的路径。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发条件的序号。取值范围：1~10
- 第三个N：表示路径的序号。取值范围：1 ～ 10。
- 多条路径间使用 & 符号分隔。当您指定多条路径时，这些路径之间是“或”的关系。
- 仅支持绝对路径。ALB 允许您使用非正则表达式或正则表达式来指定路径。如需使用正则表达式来指定路径，请提交工单进行申请。
- 指定的路径须满足以下要求：
- 非正则表达式：
- 必须以正斜线（/）开头。
- 只能包含英文字母、数字和以下特殊字符 - _ / . % ? # &＝。正斜线（/）不能连用。
- 最多允许 128 个字符。
- 正则表达式：
- 必须以波浪号（ ~ ）开头，且波浪号（ ~ ）只能出现一次。
- 仅允许包含英文字母、数字和以下特殊字符. - _ / ＝ ? ~ ^ * $ : ( ) [ ] + |。
- ~ 开头表示区分大小写。~* 开头表示不区分大小写。
- 最多允许 128 个字符。
Rules.N.RuleConditions.N.HeaderConfig.Key string[] 可选 示例值：Rules.1.RuleConditions.1.HeaderConfig.Key=test
（标准版）转发条件HTTP标头的键。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发条件的序号。取值范围：1～10。
- 第三个N：表示键的序号。取值范围：1~10。
- 同一条转发规则内，键不能相同。指定的键需满足以下要求：
- 只能包含英文字母、数字、连字符（-）和下划线（_）。
- 不能为 Cookie 和 Host。
- 最多允许 40 个字符。
Rules.N.RuleConditions.N.HeaderConfig.Values.N string[] 可选 示例值：Rules.1.RuleConditions.1.HeaderConfig.Values.1=test
（标准版）转发条件HTTP标头的值。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发条件的序号。取值范围：1～10。
- 第三个N：表示HTTP标头值的序号。取值范围：1～10。
- 每个键可以对应多个值，这些值之间是“或”的关系。指定的值需满足以下要求：
- 允许可打印的 ASCII 字符、星号（*）和半角问号（?）。
- 不能以空格作为开头和结尾。
- 最多允许 128 个字符。
Rules.N.RuleActions.N.Type string[] 可选 示例值：Rules.1.RuleActions.1.Type=ForwardGroup
（标准版）转发动作的类型。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号。取值范围：1～5。
- 取值如下：
- ForwardGroup：转发至。ALB 将请求转发至您指定的后端服务器组。
- Redirect：重定向至。ALB 对请求进行重定向。
- Rewrite：重写。ALB 改写请求路径，向后端服务器请求新路径下的内容。
- TrafficLimit: 限速。当请求数量超过配置的 QPS 时，ALB 会丢弃新的请求。
- FixedResponse：返回固定内容。自定义响应状态码和响应内容。
- Cors：跨域。支持跨域，即客户端请求的协议、域名、端口中任意一个与服务器返回页面的地址存在差异。
- InsertHeader：写入Header。在请求头里新增一条键:值数据，随请求一起发给后端服务器。
- 当多个转发动作组合配置时，这些转发动作之间是“且”的关系。
- 限速与重写需搭配转发至或重定向至使用。跨域和写入Header需搭配转发至、重定向至或返回固定响应使用。
Rules.N.RuleActions.N.ForwardGroupConfig.ServerGroupTuples.N.ServerGroupId string[] 可选 示例值：Rules.1.RuleActions.1.ForwardGroupConfig.ServerGroupTuples.1.ServerGroupId=sg-xxx
（标准版）请求被转发到的后端服务器组的 ID。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号。取值范围：1～5。
- 第三个N：表示服务器组的序号。取值范围：1～5。
Rules.N.RuleActions.N.ForwardGroupConfig.ServerGroupTuples.N.Weight integer[] 可选 示例值：Rules.1.RuleActions.1.ForwardGroupConfig.ServerGroupTuples.1.Weight=100
（标准版）后端服务器组的权重。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号。取值范围：1～5。
- 第三个N：表示服务器组的序号。取值范围：1～5。
- 取值范围：0～100。
- 如果服务器组数量为1，且未指定此参数时，参数值默认为100。
Rules.N.RuleActions.N.ForwardGroupConfig.ServerGroupStickySession.Enabled string[] 可选 示例值：Rules.1.RuleActions.1.ForwardGroupConfig.ServerGroupStickySession.Enabled=on
（标准版）是否开启服务器组间会话保持。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号。取值范围：1～5。
- 取值如下：
- on：开启。
- off（默认值）：不开启。
Rules.N.RuleActions.N.ForwardGroupConfig.ServerGroupStickySession.Timeout integer[] 可选 示例值：Rules.1.RuleActions.1.ForwardGroupConfig.ServerGroupStickySession.Timeout=1000
（标准版）服务器组间会话保持的超时时间。取值范围：1 ~ 86400 。默认值：1000 。单位：秒。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号。取值范围：1～5。
Rules.N.RuleActions.N.RedirectConfig.Host string[] 可选 示例值：Rules.1.RuleActions.1.RedirectConfig.Host=www.test.com
（标准版）重定向到的域名。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号。 取值范围：1~5。
- 指定的域名须满足以下要求：
- 只能包含英文字母、数字、半角句号（.）和连字符（-）。
- 须至少包含一个半角句号（.），但不能以半角句号（.）作为开头和结尾。
- 域名的每一级开头和结尾不能是连字符（-）。
- 最多允许 128 个字符。
- 必须是符合域名规范的精确域名，例如 www.test.com。
- 如果您不指定域名，重定向到的域名与请求的域名相同。
Rules.N.RuleActions.N.RedirectConfig.HttpCode string[] 可选 示例值：Rules.1.RuleActions.1.RedirectConfig.HttpCode=302
（标准版）重定向的状态码。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号。取值范围：1~5。
- 取值范围：
- 301（默认值）
- 302
- 307
- 308
Rules.N.RuleActions.N.RedirectConfig.Path string[] 可选 示例值：Rules.1.RuleActions.1.RedirectConfig.Path=/test
（标准版）重定向的路径。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号。 取值范围：1~5。
- 路径需遵守以下规范：
- 必须以正斜线（/）开头。
- 最多允许 128 个字符。
- 仅允许英文字母、数字和以下特殊字符：- _ / . % ? # &＝。不允许使用连续的正斜线（/）。
- 支持精确路径和正则表达式：
- 精确路径
- 输入规范：
- 必须以正斜线（/）开头。
- 仅允许英文字母、数字和以下特殊字符： - _ / . % ? # * & ＝。不允许使用连续的正斜线（/）。
- 默认为精准匹配，也支持星号（*）和半角问号（?）作为通配符使用。
- 最多允许 128 个字符。
- 取值示例：
- 精准匹配：路径配置为/api/v1/users，请求/api/v1/users可匹配成功。
- 前缀匹配：路径配置为/api/*，请求/api/v1/users和/api/v2均可匹配成功。
- 正则表达式
- 输入规范：
- 值必须以波浪号（）开头，且波浪号（）只能出现一次。
- 仅允许英文字母、数字和以下特殊字符：. - _ / ＝ ? ~ ^ * $ : ( ) [ ] + |。
- ~ 开头表示区分大小写。~* 开头表示不区分大小写。
- 取值示例：~^/api/v[0-9]+/users/.*$
- 若您在转发条件指定的路径中使用圆括号( )创建了捕获组，则可以在转发动作指定的路径中使用${1}、${2}、${3}等占位符。这些占位符与捕获组按顺序对应，${1} 表示第一个捕获组，${2} 表示第二个捕获组，以此类推。在处理请求时，ALB 会将这些占位符替换为相应捕获组匹配到的路径片段。例如，假设转发条件中指定的路径为/volc/(.*)/(.*)/aaa，转发动作中指定的路径为/${1}/${2}。如果请求路径为/volc/ccc/bbb/aaa，ALB 会将 ${1} 替换为 ccc，将 ${2} 替换为 bbb。最终的重定向路径为/ccc/bbb。
Rules.N.RuleActions.N.RedirectConfig.Port string[] 可选 示例值：Rules.1.RuleActions.1.RedirectConfig.Port=443
（标准版）重定向的端口。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号。取值范围：1～5。
- 取值范围：1~65535。
- 如果您不指定端口，重定向到的端口与请求的端口相同。
Rules.N.RuleActions.N.RedirectConfig.Protocol string[] 可选 示例值：Rules.1.RuleActions.1.RedirectConfig.Protocol=HTTPS
（标准版）重定向的协议。
- 第一个N：表示转发规则的序号。取值范围：1～10000。
- 第二个N：表示转发动作的序号， 取值范围：1~5。
- 取值范围：
- HTTP
- HTTPS（默认值）
Rules.N.RuleActions.N.RewriteConfig.Path string[] 可选 示例值：Rules.1.RuleActions.1.RewriteConfig.Path=/test
（标准版）重写后的路径。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。 取值范围：1~5。
- 指定的路径须满足以下要求：
- 路径长度不能超过 128 个字符。
- 路径必须以正斜线（ / ）开头。
- 路径中只能包含英文字母、数字和以下特殊字符 - _ / . % ? # &＝。正斜线（/）不能连用。
- 如果您在转发条件的路径中使用了正则表达式并使用半角圆括号( )创建了捕获组，您可以在转发动作的路径中使用${1}、${2}、${3}等变量来引用捕获到的内容。举例：假设转发条件中指定的路径为/volc/(.)/(.)/aaa，转发动作中指定的路径为/${1}/${2}。当请求的路径为/volc/ccc/bbb/aaa时，该路径会将被替换为/ccc/bbb。
Rules.N.RuleActions.N.TrafficLimitConfig.QPS integer[] 可选 示例值：Rules.1.RuleActions.1.TrafficLimitConfig.QPS=100
（标准版）QPS限速值。
- 第一个N：表示转发规则的序号。取值范围：1 ～ 10000。
- 第二个N：表示转发动作的序号。 取值范围：1~5。
- QPS表示每秒请求数。取值范围：100～100000。
- “限速”必须搭配“转发至”使用。当您需要配置“限速”时，须将“限速”配置为第一个转发动作。
ListenerId string 必选 示例值：lsn-2fea4ayvu2g3k5oxruuz****
监听器ID。
Rules.N.ServerGroupId string[] 可选 示例值：Rules.1.ServerGroupId=rsp-bp1o94dp5i6ea****&Rules.2.ServerGroupId=rsp-2fea4bshkqv405oxruuz4****
（基础版）转发到后端服务器组的ID。
- 参数-N：表示转发规则的序号，取值范围为1 ～ 20。当转发规则动作为空，即转发至服务器组，该参数为必填项。
- 多个转发规则间使用“&”分隔。
返回参数
RequestId string 示例值：20210811152539010225146063030****
请求ID。
RuleIds string[] 示例值：["rule-****","rule- ****"]
转发规则ID。
请求示例
GET /?Action=CreateRules&ListenerId=lsn-1g0puwcxuf****ibuxxw2pmf7&Rules.1.Domain=test.com&Rules.1.ServerGroupId=rsp-3ciynvqsspiww****rsz73tzn&Rules.1.Url=/test&Version=2020-04-01 HTTP/1.1
Host: alb.cn-beijing.volcengineapi.com
X-Date: 20251121T094038Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/alb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
返回示例
{
"ResponseMetadata": {
"RequestId": "202108131613570****5146063000AD724",
"Action": "CreateRules",
"Version": "2020-04-01",
"Service": "alb",
"Region": "cn-beijing"
},
"Result": {
"RequestId": "2021081316135****225146063000AD724",
"RuleIds": [
"rule-3ciynwk****b46c6rrt4jszkd"
]
}
}
错误码
最近更新时间：2026.09.11 17:04:39
这个页面对您有帮助吗？
有用
有用
无用
无用