调用 CreateRules 接口，为监听器添加转发规则，将来自不同域名、URL的访问请求转发到不同的服务器组。 ## 使用说明 * 每秒最多提交5个API请求。 * 本API适用于基础版ALB和标准版ALB： * 若参数注明基础版，则该参数为基础版ALB独有。 * 若参数注明标准版，则该参数为标准版ALB独有。 * 若参数未标注，则为基础版ALB和标准版ALB共有。 ## 调试 ## 请求参数下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6369/67268)。 **Action** string %%require%% `示例值：CreateRules` 要执行的操作，取值：CreateRules。 **Version** string %%require%% `示例值：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.Description** string[] `可选` `示例值：-` 转发规则的描述。 * 参数\- N：表示转发规则的序号，取值范围为1 ～ 20。 * 多个转发规则间使用“&”分隔。 * 具体规范如下： * 不填默认为空字符串。 * 不能超过 255 个字符。 * 必须以英文字母或汉字开头。 * 只能包含英文字母、汉字、数字、空格和以下特殊字符,._=\-，。。 **Rules.N.Url** string[] `可选` `示例值：/` （基础版）转发规则的Url。 * 仅支持绝对路径。ALB 允许您指定精确路径或使用正则表达式来指定路径。ALB使用正则表达式正在邀侧中，如需试用，请联系客户经理。 * 指定的路径须满足以下要求： * 精确路径： * 必须以正斜线（/）开头。 * 只能包含英文字母、数字和以下特殊字符：\- _ / . % ? # &＝。正斜线（/）不能连用。 * 最多允许 128 个字符。 * 正则表达式： * 必须以波浪号（ ~ ）开头，且波浪号（ ~ ）只能出现一次。 * 仅允许包含英文字母、数字和以下特殊字符：. \- _ / ＝ ? ~ ^ \* $ : ( ) [ ] + | 。 * ~ 开头表示区分大小写。~\* 开头表示不区分大小写。 * 最多允许 128 个字符。 :::tip * 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` （基础版）转发动作。取值如下： * 空值（默认值）：转发至。ALB 将请求转发至您指定的后端服务器组。 * Redirect：重定向。ALB 对请求进行重定向。 **Rules.N.RewriteEnabled** string[] `可选` `示例值：on` （基础版）是否开启“重写”功能。取值如下： * on：开启。 * off（默认值）：关闭。 :::tip * 仅当 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限速开关。取值如下： * on：开启。 * off：关闭（默认）。 **Rules.N.TrafficLimitQPS** integer[] `可选` `示例值：100` （基础版）QPS限速值。 * 当 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` （基础版）转发条件中的域名。 * 基本输入规范： * 只能包含英文字母、数字和以下特殊字符：. \- _ \*。 * 须至少包含一个半角句号（.），但不能以半角句号（.）作为开头和结尾。 * 最多允许 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` （基础版）组件会话保持的超时时间。单位：秒。 * 取值范围：**1** ~ **86400** 。 * 默认值：**1000** 。 **Rules.N.ForwardGroupConfig.StickySessionEnabled** string[] `可选` `示例值：Rules.1.ForwardGroupConfig.StickySessionEnabled=on` （基础版）是否开启组间会话保持。取值如下： * **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` （标准版）转发规则返回的固定内容。 * 最长1024个字符。 * 只支持 utf\-8字符。 **Rules.N.RuleActions.N.FixedResponseConfig.ContentType** string[] `可选` `示例值：Rules.1.RuleActions.1.FixedResponseConfig.ContentType=text/plain` （标准版）转发规则返回固定内容的格式。取值如下： * 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响应码。仅支持 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` （标准版）转发条件的查询字符串键。 * 长度为 1~100 个字符。 * 支持可见字符、通配符星号（\*）和半角问号（？），如果是字母则必须为小写字母。不支持空格和#[]{}|<\>&"。 **Rules.N.RuleConditions.N.QueryStringConfig.Values.N.Value** string[] `可选` `示例值：Rules.1.RuleConditions.1.QueryStringConfig.Values.1.Value=1.0.` （标准版）转发条件的查询字符串值。 * 长度为 1~128 个字符。 * 支持小写字母、可见字符和通配符星号（\*）和半角问号（？），不支持空格和#[]{}|<\>&"。 **Rules.N.Priority** integer[] `可选` `示例值：Rules.1.Priority=1&Rules.2.Priority=2` （标准版）转发规则优先级。 **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：表示值的序号。取值范围：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：返回固定内容。自定义响应状态码和响应内容。 * “限速”和“重写”转发动作必须和“转发至”转发动作配合使用。“限速”、“重写”和“转发至”三者也可以配合使用。当多个转发动作组合配置时，这些转发动作之间是“且”的关系。 **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` （标准版）是否开启服务器组间会话保持。取值范围： * 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 个字符。 * 只能包含英文字母、数字和以下特殊字符 \- _ / . % ? # &＝。正斜线（/）不能连用。 * 如果您不指定路径，重定向到的路径与请求的路径相同。 **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 %%require%% `示例值：lsn-2fea4ayvu2g3k5oxruuz****` 监听器ID。 **Rules.N.ServerGroupId** string[] `可选` `示例值：Rules.1.ServerGroupId=rsp-bp1o94dp5i6ea****&Rules.2.ServerGroupId=rsp-2fea4bshkqv405oxruuz4****` （基础版）转发到后端服务器组的ID。 * 参数\-N：表示转发规则的序号，取值范围为1 ～ 20。当转发规则动作为空，即转发至服务器组，该参数为必填项。 * 多个转发规则间使用“&”分隔。 ## 返回参数下方仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6369/80336)。 **RequestId** string `示例值：20210811152539010225146063030****` 请求ID。 **RuleIds** string[] `示例值：["rule-****","rule- ****"]` 转发规则ID。 ## 请求示例 ```text 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 ``` ## 返回示例 ```json { "ResponseMetadata": { "RequestId": "202108131613570****5146063000AD724", "Action": "CreateRules", "Version": "2020-04-01", "Service": "alb", "Region": "cn-beijing" }, "Result": { "RequestId": "2021081316135****225146063000AD724", "RuleIds": [ "rule-3ciynwk****b46c6rrt4jszkd" ] } } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见[公共错误码](https://www.volcengine.com/docs/6369/68677)文档。 |状态码 |错误码 |错误信息 |说明 | |---|---|---|---| |400 |Invalid%s.Malformed |MismatchThe specified %s is malformed. |指定的 %s 参数格式不合法。 | |400 |MissingParameter |The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, '%s'. |该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: %s。 | |400 |InvalidParameter |Data unmarshal failed. |请求解析失败。 | |400 |OperationDenied.RewriteEnabledInRedirectAction |The request on the specified Rule is denied due to the rewrite config is not allowed to be configured in redirect action. |因重定向转发动作不支持重写功能，对于该转发规则的操作请求被拒绝。 | |400 |OperationDenied.AccountArrears |The request on the specified resource is denied due to the account being in arrears status. |因账号处于欠费状态，对于该资源的操作请求被拒绝。 | |400 |InvalidRules.RedirectConfig.RedirectHttpCode.Malformed |The specified Rules.RedirectConfig.RedirectHttpCode is malformed. |指定的 Rules.RedirectConfig.RedirectHttpCode 参数格式不合法。 | |400 |InvalidVpcForServerGroup.LoadBalancerMismatch |The specified VPC of ServerGroup and LoadBalancer do not match. |指定的服务器组和 ALB 实例的 VPC 不匹配。 | |400 |MissingParameter |The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules.ServerGroupId'. |该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules.ServerGroupId。 | |400 |InvalidRules.Description.Malformed |The specified Rules.Description is malformed. |指定的 Rules.Description 参数格式不合法。 | |400 |InvalidRules.Url.Duplicated |The specified Rules.Url is duplicated. |指定的 Rules.Url 重复。 | |400 |InvalidRules.Url.Malformed |The specified Rules.Url is malformed. |指定的 Rules.Url 参数格式不合法。 | |400 |InvalidRules.Domain.Malformed |The specified Rules.Domain is malformed. |指定的 Rules.Domain 参数格式不合法。 | |400 |OperationDenied.DefaultRule |The request on the specified rule is denied due to the default rule can not be added. |因默认转发规则不支持人为添加，对于该转发规则的操作请求被拒绝。 | |400 |InvalidRules.TrafficLimitQPS.Malformed |The specified Rules.TrafficLimitQPS is malformed. |指定的 Rules.TrafficLimitQPS 参数格式不合法。 | |400 |InvalidRules.TrafficLimitEnabled.Malformed |The specified Rules.TrafficLimitEnabled is malformed. |指定的 Rules.TrafficLimitEnabled 参数格式不合法。 | |400 |LimitExceed.Rule |You've reached the limit on the number of rules that you can operate at a time. |已达到单次可操作的转发规则的数量上限。 | |400 |InvalidRules.RedirectConfig.Malformed |The specified Rules.RedirectConfig is malformed. |指定的 Rules.RedirectConfig 参数格式不合法。重定向协议与监听器协议一致，域名、端口、URI 至少填写一项。 | |400 |InvalidServerGroup.InvalidStatus |The specified ServerGroup is not in the correct status for the request. |指定的服务器组所处状态无法响应该请求。 | |400 |InvalidLoadBalancer.InvalidStatus |The related LoadBalancer is not in the correct status for the request. |关联的 ALB 实例所处状态无法响应该请求。 | |400 |QuotaExceed.RulePerGroup |You've reached the limit on the number of rules per server group you can associate with, resource xxx, usage xx/xx. |已达到每个服务器组可关联转发规则的数量上限。资源是xxx，目前已使用xxx，配额为xxx。 | |400 |QuotaExceed.ServerPerInstance |You've reached the limit on the number of backend servers per ALB you can associate with, resource xxx, usage xx/xx. |已达到每个实例可关联的后端服务器的数量上限。资源是xxx，目前已使用xxx，配额为xxx。 | |400 |QuotaExceed.RulePerInstance |You've reached the limit on the number of rules per ALB you can create in, resource xxx, usage xx/xx. |已达到每个实例可创建转发规则的数量上限。资源是xxx，目前已使用xxx，配额为xxx。 | |400 |InvalidRules.RewriteConfig.RewritePath.Malformed |The specified Rules.RewriteConfig.RewritePath is malformed. |指定的 Rules.RewriteConfig.RewritePath 参数格式不合法。 | |400 |InvalidRules.RuleAction.Malformed |The specified Rules.RuleAction is malformed. |指定的 Rules.RuleAction 参数格式不合法。 | |400 |InvalidRules.RedirectConfig.RedirectPort.Malformed |The specified Rules.RedirectConfig.RedirectPort is malformed. |指定的 Rules.RedirectConfig.RedirectPort 参数格式不合法。 | |400 |InvalidRules.RedirectConfig.RedirectUri.Malformed |The specified Rules.RedirectConfig.RedirectUri is malformed. |指定的 Rules.RedirectConfig.RedirectUri 参数格式不合法。 | |400 |InvalidRules.RedirectConfig.RedirectDomain.Malformed |The specified Rules.RedirectConfig.RedirectDomain is malformed. |指定的 Rules.RedirectConfig.RedirectDomain 参数格式不合法。 | |400 |InvalidRules.RedirectConfig.RedirectProtocol.Malformed |The specified Rules.RedirectConfig.RedirectProtocol is malformed. |指定的 Rules.RedirectConfig.RedirectProtocol 参数格式不合法。 | |400 |InvalidIndexOrder.Malformed |The specified index order is malformed. |指定的索引顺序参数格式不合法。 | |400 |InvalidRules.RewriteEnabled.Malformed |The specified Rules.RewriteEnabled is malformed. |指定的 Rules.RewriteEnabled 参数格式不合法。 | |400 |InvalidRules.ForwardGroupConfig.ServerGroupTuples.ServerGroupId.Duplicated |The specified Rules.ForwardGroupConfig.ServerGroupTuples.ServerGroupId is duplicated. |指定的Rules.ForwardGroupConfig.ServerGroupTuples.ServerGroupId重复。 | |400 |InvalidRules.ForwardGroupConfig.StickySessionEnabled.Malformed |The specified Rules.ForwardGroupConfig.StickySessionEnabled is malformed. |指定的 Rules.ForwardGroupConfig.StickySessionEnabled 参数格式不合法。 | |400 |InvalidRules.ForwardGroupConfig.ServerGroupTuples.Weight.Malformed |The specified Rules.ForwardGroupConfig.ServerGroupTuples.Weight is malformed. |指定的 Rules.ForwardGroupConfig.ServerGroupTuples.Weight 参数格式不合法。 | |400 |InvalidRules.ForwardGroupConfig.StickySessionTimeout.Malformed |The specified Rules.ForwardGroupConfig.StickySessionTimeout is malformed. |指定的 Rules.ForwardGroupConfig.StickySessionTimeout 参数格式不合法。 | |400 |InvalidRules.ForwardGroupConfig.Malformed |Either ForwardGroupConfig or ServerGroupID must be specified |转发规则中 ForwardGroupConfig、ServerGroupID 至少填写一项 | |400 |LimitExceed.ServerGroupTuple |You've reached the limit on the number of server group tuples that you can associate with the rule. |已达到单个转发规则可关联的服务器组的数量上限。 | |400 |InvalidRules.RuleConditions.HeaderConfig.Key.Malformed |The specified Rules.RuleConditions.HeaderConfig.Key is malformed. |指定的 Rules.RuleConditions.HeaderConfig.Key 参数格式不合法。 | |400 |LimitExceed.Rules.Wildcard |You've reached the limit on the number of wildcard characters you can use in the rule. |已达到单个转发规则可使用的通配符数量上限。 | |400 |InvalidRules.Priority.Duplicated |The specified Rules.Priority is duplicated. |指定的 Rules.Priority 重复。 | |400 |LimitExceed.Rules.Actions |You've reached the limit on the number of actions you can associate with the rule. |已达到单个转发规则可添加的转发动作数量上限。 | |400 |InvalidPriorityOrder.Malformed |The specified priority order is malformed. |指定的优先级顺序参数格式不合法。 | |400 |LimitExceed.Rules.Conditions |You've reached the limit on the number of conditions you can associate with the rule. |已达到单个转发规则可添加的转发条件数量上限。 | |400 |InvalidTypeOfRule.LoadBalancerEditionMismatch |The type of Rule and LoadBalancer edition do not match. |转发规则类型与实例版本不匹配。 | |400 |InvalidRules.Priority.Malformed |The specified Rules.Priority is malformed. |指定的 Rules.Priority 参数格式不合法。 | |400 |InvalidRules.RuleConditions.HeaderConfig.Values.Malformed |The specified Rules.RuleConditions.HeaderConfig.Values is malformed. |指定的 Rules.RuleConditions.HeaderConfig.Values 参数格式不合法。 | |400 |InvalidRules.RuleActions.Type.Malformed |The specified Rules.RuleActions.Type is malformed. |指定的 Rules.RuleActions.Type 参数格式不合法。 | |400 |InvalidRules.RuleConditions.Type.Malformed |The specified Rules.RuleConditions.Type is malformed. |指定的 Rules.RuleConditions.Type 参数格式不合法。 | |400 |InvalidRules.RuleActions.TrafficLimitConfig.QPS.Malformed |The specified Rules.RuleActions.TrafficLimitConfig.QPS is malformed. |指定的 Rules.RuleActions.TrafficLimitConfig.QPS 参数格式不合法。 | |400 |InvalidRules.RuleConditions.HostConfig.Values.Malformed |The specified Rules.RuleConditions.HostConfig.Values is malformed. |指定的 Rules.RuleConditions.HostConfig.Values 参数格式不合法。 | |400 |InvalidRules.RuleConditions.PathConfig.Values.Malformed |The specified Rules.RuleConditions.PathConfig.Values is malformed. |指定的 Rules.RuleConditions.PathConfig.Values 参数格式不合法。 | |400 |InvalidRules.RuleActions.RedirectConfig.Malformed |The specified Rules.RuleActions.RedirectConfig is malformed. |指定的 Rules.RuleActions.RedirectConfig 参数格式不合法。重定向协议与监听器协议一致，域名、端口、URI 至少填写一项 | |400 |InvalidRules.RuleActions.RedirectConfig.Host.Malformed |The specified Rules.RuleActions.RedirectConfig.Host is malformed. |指定的 Rules.RuleActions.RedirectConfig.Host 参数格式不合法。 | |400 |InvalidRules.RuleActions.RedirectConfig.Path.Malformed |The specified Rules.RuleActions.RedirectConfig.Path is malformed. |指定的 Rules.RuleActions.RedirectConfig.Path 参数格式不合法。 | |400 |InvalidRules.RuleActions.RedirectConfig.Port.Malformed |The specified Rules.RuleActions.RedirectConfig.Port is malformed. |指定的 Rules.RuleActions.RedirectConfig.Port 参数格式不合法。 | |400 |InvalidRules.RuleConditions.PathConfig.Duplicated |The specified Rules.RuleConditions.PathConfig is duplicated. |指定的Rules.RuleConditions.PathConfig重复。 | |400 |InvalidRules.RuleConditions.HostConfig.Duplicated |The specified Rules.RuleConditions.HostConfig is duplicated. |指定的Rules.RuleConditions.HostConfig重复。 | |400 |InvalidRules.RuleActions.ForwardGroupConfig.ServerGroupTuples.ServerGroupId.Duplicated |The specified Rules.RuleActions.ForwardGroupConfig.ServerGroupTuples.ServerGroupId is duplicated. |指定的服务器组 ID 重复。 | |400 |InvalidRules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Enabled.Malformed |The specified Rules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Enabled is malformed. |指定的 Rules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Enabled 参数格式不合法。 | |400 |InvalidRules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Timeout.Malformed |The specified Rules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Timeout is malformed. |指定的 Rules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Timeout 参数格式不合法。 | |400 |InvalidRules.RuleActions.RewriteConfig.Malformed |The specified Rules.RuleActions.RewriteConfig is malformed.Please specify one rewrite config at least. |指定的 Rules.RuleActions.RewriteConfig 参数格式不合法。请至少指定一项重写配置。 | |400 |InvalidRules.RuleActions.RewriteConfig.Path.Malformed |The specified Rules.RuleActions.RewriteConfig.Path is malformed. |指定的 Rules.RuleActions.RewriteConfig.Path 参数格式不合法。 | |400 |InvalidRules.RuleActions.RedirectConfig.Protocol.Malformed |The specified Rules.RuleActions.RedirectConfig.Protocol is malformed. |指定的 Rules.RuleActions.RedirectConfig.Protocol 参数格式不合法。 | |400 |InvalidRules.RuleActions.RedirectConfig.HttpCode.Malformed |The specified Rules.RuleActions.RedirectConfig.HttpCode is malformed. |指定的 Rules.RuleActions.RedirectConfig.HttpCode 参数格式不合法。 | |400 |InvalidRules.RuleActions.ForwardGroupConfig.ServerGroupTuples.Weight.Malformed |The specified Rules.RuleActions.ForwardGroupConfig.ServerGroupTuples.Weight is malformed. |指定的 Rules.RuleActions.ForwardGroupConfig.ServerGroupTuples.Weight 参数格式不合法。 | |400 |InvalidRules.RuleConditions.PathConfig.Values.Duplicated |The specified Rules.RuleConditions.PathConfig.Values is duplicated. |指定的Rules.RuleConditions.PathConfig.Values重复。 | |400 |InvalidPriority.RuleActionMismatch |The specified priority and action of rule do not match.The traffic\-limit\-type rule action must have the first priority. |指定的转发动作和优先级不匹配。限速类转发动作的优先级必须放在最前。 | |400 |OperationDenied.MultipleForwardActions |The request on the specified Rule is denied due to multiple forward actions. |因转发规则，对于该一条转发规则包含多个转发类动作的操作请求被拒绝。 | |400 |OperationDenied.TrafficLimitMustUsedWithForward |The request on the specified Rule is denied due to the traffic limit rule action must used with forward rule action. |因转发规则，对于该限速转发动作必须搭配转发至转发动作的操作请求被拒绝。 | |400 |OperationDenied.MissingForwardAction |The request on the specified Rule is denied due to the forward\-type action does not exist. |因转发规则，对于该缺少转发类转发动作的操作请求被拒绝。 | |400 |InvalidRules.RuleConditions.HeaderConfig.Values.Duplicated |The specified Rules.RuleConditions.HeaderConfig.Values is duplicated. |指定的Rules.RuleConditions.HeaderConfig.Values重复。 | |400 |InvalidRules.RuleConditions.HeaderConfig.Key.Duplicated |The specified Rules.RuleConditions.HeaderConfig.Key is duplicated. |指定的Rules.RuleConditions.HeaderConfig.Key重复。 | |400 |InvalidRules.RuleConditions.HostConfig.Values.Duplicated |The specified Rules.RuleConditions.HostConfig.Values is duplicated. |指定的Rules.RuleConditions.HostConfig.Values重复。 | |400 |InvalidRules.RuleActions.TrafficLimitConfig.Duplicated |The specified Rules.RuleActions.TrafficLimitConfig is duplicated. |指定的Rules.RuleActions.TrafficLimitConfig重复。 | |400 |InvalidRules.RuleActions.RewriteConfig.Duplicated |The specified Rules.RuleActions.RewriteConfig is duplicated. |指定的Rules.RuleActions.RewriteConfig重复。 | |400 |InvalidRules.RuleActions.RewriteConfig.Host.Malformed |The specified Rules.RuleActions.RewriteConfig.Host is malformed. |指定的 Rules.RuleActions.RewriteConfig.Host 参数格式不合法。 | |403 |Forbidden |You are not authorized to configure rewrite host for rules. |您无权限对指定转发规则配置重写域名。 | |403 |Forbidden |You are not authorized to configure rewrite for rule. |您无权限对指定转发规则配置重写。 | |404 |InvalidServerGroup.NotFound |The specified ServerGroup does not exist. |指定的服务器组不存在。 | |404 |InvalidListener.NotFound |The specified Listener does not exist. |指定的监听器不存在。 | |409 |InvalidRules.Conflict |The specified Rule already exists. |指定的转发规则已存在。 | |500 |InternalError |An internal error has occurred. |发生内部错误。请稍后重试或联系工程师进一步咨询。 |