You need to enable JavaScript to run this app.
导航
应用型负载均衡
  • 文档首页
    • /应用型负载均衡/开发指南/API 参考/转发规则/ModifyRules
ModifyRules
最近更新时间：2025.04.17 11:56:34首次发布时间：2022.05.20 22:34:54
我的收藏
有用
有用
无用
无用

请求说明

API 名称：ModifyRules。
API 域名：open.volcengineapi.com。
API 描述：修改指定监听器转发规则。

使用限制

节流限制：每秒最多提交 5 个 API 请求。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称类型是否必选格式说明
Action
String
是
[a-zA-Z]+
API 名称，如 ModifyRules。
VersionString是YYYY-MM-DDAPI 版本信息。该参数的取值是 2020-04-01 。
X-ExpiresInteger否900表示签名的有效时间，单位是秒，默认值是900。

请求参数

在使用该 API 提交请求时，请求参数中可以包含的参数如下。

参数类型是否必选参数说明示例值
ListenerId
String
是
监听器 ID。
lsn-2fea4ayvu2g3k5oxruuz****
RulesArray是配置转发规则相关信息。详见 Rules（基础版）和 Rules（标准版）。-

Rules（基础版）

参数类型是否必选参数说明示例值

Rules.N.RuleId

String

是

转发规则的 ID。

  • N：表示转发规则的序号。取值范围：1~20。

  • 多个转发规则间使用 & 分隔。

Rules.1.RuleId=rule-2fes****&Rules.2.RuleId=rule-hsg3s****

Rules.N.RuleAction

String

否

转发动作。取值范围：

  • 空值：转发至。ALB 将请求转发至您指定的后端服务器组。

  • Redirect：重定向。ALB 对请求进行重定向。

注意事项：
如果您不指定该参数，该参数的值将被置为默认值（空值），即转发动作被设置为“转发至”。

Rules.1.RuleAction="&Rules.2.RuleAction=Redirect

Rules.N.ServerGroupId

String

否

请求被转发到的后端服务器组的 ID。

  • N：表示转发规则的序号。取值范围：1～20。

  • 多个后端服务器组间使用 & 分隔。

注意事项：
当 Rules.N.RuleAction 值为空（即转发动作为“转发至”）时，必须指定该参数或 Rules.N.ForwardGroupConfig.ServerGroupTuples.N.ServerGroupId 参数。Rules.N.ForwardGroupConfig.ServerGroupTuples.N.ServerGroupId 参数的优先级更高。如果两个参数同时指定，Rules.N.ServerGroupId 参数会被忽略。

Rules.1.ServerGroupId=rsp-bp1o94dp5i6ea****&Rules.2.ServerGroupId=rsp-2fea4bshkqv405oxruuz4****

Rules.N.ForwardGroupConfig

Struct

否

服务器组配置，具体可参见 ForwardGroupConfig。
注意事项： 该参数适用于多个后端服务器组的场景。如需使用该参数配置多个后端服务器组，请提交工单进行申请。

-

Rules.N.RedirectConfigStruct否重定向配置，具体可参见 RedirectConfig。-

Rules.N.RewriteEnabled

String

否

是否开启“重写”功能。取值范围：

  • on：开启。

  • off：关闭。

注意事项：

  • 如果您不配置该参数，表示不修改“重写”相关配置。

  • 如果您配置了该参数，ALB 会清空之前配置的 Rules.N.RewriteConfig.RewritePath 参数的值。

  • 如果您将 Rules.N.RewriteEnabled 的值由 on 变更为 off，ALB 会清空之前配置的 Rules.N.RewriteConfig.RewritePath 参数的值。

  • 如果您将 Rules.N.RewriteEnabled 的值由 off 变更为 on，您需要同时配置 Rules.N.RewriteConfig.RewritePath。否则，参数值不生效。

  • 仅当 Rules.N.RuleAction 值为空（即转发动作为“转发至”）时，允许配置该参数。否则，参数值不生效。

  • 如需使用“重写”功能，请提交工单进行申请。

Rules.1.RewriteEnabled=on

Rules.N.RewriteConfig

Struct

否

重写配置，具体可参见 RewriteConfig。
注意事项： 您需要先开启“重写”功能后，才能指定该参数。

-

Rules.N.TrafficLimitEnabled

String

否

是否开启 QPS 限速。开启该功能后，当客户端请求数量超过设置的 QPS，ALB 会拒绝超出限制的请求，并返回 503 状态码给客户端。
取值范围：

  • on：开启。

  • off：关闭。

注意事项：

  • 如果您不配置该参数，表示不修改限速相关信息。

  • 如果您配置了该参数，ALB 会清空之前配置的 Rules.N.TrafficLimitQPS 参数的值。

  • 如果您将 Rules.N.TrafficLimitEnabled 的值由 on 变更为 off，ALB 会清空之前配置的 Rules.N.TrafficLimitQPS 参数的值。

  • 如果您将 Rules.N.TrafficLimitEnabled 的值由 off 变更为 on，您需要同时配置 Rules.N.TrafficLimitQPS。

Rules.1.TrafficLimitEnabled=on

Rules.N.TrafficLimitQPS

Integer

否

限速 QPS （每秒请求数）。取值范围：100～150000。
当 Rules.N.TrafficLimitEnabled 的值为 on 时，您为该参数设置的值才有效。
注意事项：

  • 当 Rules.N.TrafficLimitEnabled 的值为 on 时，必须指定该参数。

  • 当 Rules.N.RuleAction 值为空（即转发动作为“转发至”）时，该参数有效。

Rules.1.TrafficLimitQPS=100

Rules.N.Description

String

否

转发规则的描述。

  • N：表示转发规则的序号。取值范围：1～20。

  • 多条描述间使用 & 分隔。

描述信息须满足以下要求：

  • 不能超过 255 个字符。

  • 必须以英文字母或汉字开头。

  • 只能包含英文字母、汉字、数字、空格和以下特殊字符,._=-，。。

Rules.1.Description=test

ForwardGroupConfig

参数

类型

是否必选

参数说明

示例值

Rules.N.ForwardGroupConfig.ServerGroupTuples.N.ServerGroupId

String

否

请求被转发到的后端服务器组的 ID。

  • N^1：表示转发规则的序号。取值范围：1～20。

  • N^2：表示服务器组的序号。取值范围：1～5。

当 Rules.N.RuleAction 值为空（即转发动作为“转发至”）时，必须指定该参数或 Rules.N.ServerGroupId 参数。该参数的优先级高于 Rules.N.ServerGroupId 参数。如果两个参数同时指定，Rules.N.ServerGroupId 参数会被忽略。

Rules.1.ForwardGroupConfig.ServerGroupTuples.2.ServerGroupId=rsp-j7vhgiusf98a

Rules.N.ForwardGroupConfig.ServerGroupTuples.N.Weight

Integer

否

后端服务器组的权重。取值范围：0~100。当服务器组数量为 1，且未指定此参数时，参数值会被置为 100。 当服务器组数量大于 1，且未指定此参数时，参数值会被置为 0。

  • N^1：表示转发规则的序号。取值范围：1～20。

  • N^2：表示服务器组的序号。取值范围：1～5。

Rules.1.ForwardGroupConfig.ServerGroupTuples.2.Weight=50

Rules.N.ForwardGroupConfig.StickySessionEnabled

String

否

是否开启组间会话保持。取值范围：

  • on：开启。

  • off（默认值）：不开启。

Rules.1.ForwardGroupConfig.StickySessionEnabled=on

Rules.N.ForwardGroupConfig.StickySessionTimeoutInteger否组间会话保持的超时时间。取值范围：1 ~ 86400。默认值：1000 。单位：秒。Rules.1.ForwardGroupConfig.StickySessionTimeout=5000

RedirectConfig

参数类型是否必选参数说明示例值

Rules.N.RedirectConfig.RedirectDomain

String

否

请求被重定向到的域名。

  • N：表示转发规则的序号。取值范围：1~20。

  • 多个域名间使用 & 分隔。

指定的域名须满足以下要求：

  • 只能包含英文字母、数字、半角句号（.）和连字符（-）。

  • 须至少包含一个半角句号（.），但不能以半角句号（.）作为开头和结尾。

  • 域名的每一级开头和结尾不能是连字符（-）。

  • 最多允许 128 个字符。

  • 必须是符合域名规范的精确域名，例如 www.test.com。

当转发动作为“重定向”（Redirect）时，若该参数不指定，参数值会被置为默认值（空值)。该情况下，重定向到的域名与请求的域名相同。

Rules.1.RedirectConfig.RedirectDomain=*.com&Rules.2.RedirectConfig.RedirectDomain=www.test.com

Rules.N.RedirectConfig.RedirectUri

String

否

请求被重定向到的路径。

  • N：表示转发规则的序号。取值范围：1~20。

  • 多条路径间使用 & 分隔。

指定的路径须满足以下要求：

  • 必须以正斜线（/）开头。

  • 最多允许 128 个字符。

  • 只能包含英文字母、数字和以下特殊字符：- _ / . % ? # &＝。正斜线（/）不能连用。

当转发动作为“重定向”（Redirect）时，若该参数不指定，参数值会被置为默认值（空值)。该情况下，重定向到的路径与请求的路径相同。

Rules.1.RedirectConfig.RedirectUrl=/&Rules.2.RedirectConfig.RedirectUrl=/foo

Rules.N.RedirectConfig.RedirectPort

Integer

否

请求被重定向到的端口。取值范围：1~65535。

  • N：表示转发规则的序号。取值范围：1~20。

  • 多个端口间使用 & 分隔。

当转发动作为“重定向”（Redirect）时，若该参数不指定，参数值会被置为默认值（空值)。该情况下，重定向到的端口与请求的端口相同。

Rules.1.RedirectConfig.RedirectPort=80&Rules.2.RedirectConfig.RedirectPort=443

Rules.N.RedirectConfig.RedirectHttpCode

Integer

否

状态码，用于表示重定向的响应。

  • N：表示转发规则的序号。取值范围：1~20。

  • 多个状态码间使用 & 分隔。

取值范围：

  • 301（默认值）

  • 302

  • 307

  • 308

当转发动作为“重定向”（Redirect）时，若该参数不指定，参数值会被置为默认值 301。

Rules.1.RedirectConfig.RedirectHttpCode=301&Rules.2.RedirectConfig.RedirectHttpCode=302

Rules.N.RedirectConfig.RedirectProtocol

String

否

重定向使用的协议。

  • N：表示转发规则的序号。取值范围：1~20。

  • 多个协议间使用 & 分隔。

取值范围：

  • HTTP

  • HTTPS（默认值）

当转发动作为“重定向”（Redirect）时，若该参数不指定，参数值会被置为默认值 HTTPS。

Rules.1.RedirectConfig.RedirectProtocol=HTTP&Rules.2.RedirectConfig.RedirectProtocol=HTTPS

RewriteConfig

参数类型是否必选参数说明示例值

Rules.N.RewriteConfig.RewritePath

String

否

重写后的路径。

  • N：表示转发规则的序号。取值范围：1~20。

  • 多条路径间使用 & 分隔。

指定的路径须满足以下要求：

  • 路径长度不能超过 128 个字符。

  • 路径必须以正斜线（ / ）开头。

  • 路径中只能包含英文字母、数字和以下特殊字符：- _ / . % ? # &＝。正斜线（/）不能连用。

  • 如果您在转发条件的路径中使用了正则表达式并使用半角圆括号( )创建了捕获组，您可以在转发动作的路径中使用${1}、${2}、${3}等变量来引用捕获到的内容。举例：假设转发条件中指定的路径为/volc/(.*)/(.*)/aaa，转发动作中指定的路径为/${1}/${2}。当请求的路径为/volc/ccc/bbb/aaa时，该路径将被替换为/ccc/bbb。

Rules.1.RewriteConfig.RewritePath=/${1}/${2}&Rules.2.RewriteConfig.RewritePath=/foo

Rules（标准版）

说明

标准版实例的转发规则中包含以下模块：Rules.N.Priority（优先级）、Rules.N.RuleConditions（转发条件）、Rules.N.RuleActions（转发动作）和 Rules.N.Description（描述）。

  • 如果您未修改一个模块（例如 Rules.N.RuleConditions 模块）中的任何参数，该模块中所有参数的值将保持不变。

  • 如果您修改了一个模块中的任何参数：1) 被修改的参数将使用新的值；2) 未被修改的参数值将被清空。

参数

类型

是否必选

参数说明

示例值

Rules.N.PriorityInteger否转发规则的优先级。取值范围：1~10000。Rules.1.Priority=1

Rules.N.RuleConditions

Array

否

转发条件，具体可参见 RuleConditions。
注意事项：

  • 各转发条件可以单独配置，也可以组合配置。当多个转发条件组合配置时，这些转发条件之间是“且”的关系。

  • 同一转发条件下可以配置多个值，这些值之间是“或”的关系。

  • 一条转发规则中，所有转发条件下的值的总个数不能超过 10。

-

Rules.N.RuleActions

Array

否

转发动作，具体可参见 RuleActions。
注意事项：
“限速”和“重写”转发动作必须和“转发至”转发动作配合使用。“限速”、“重写”和“转发至”三者也可以配合使用。当多个转发动作组合配置时，这些转发动作之间是“且”的关系。

-

Rules.N.Description

String

否

转发规则的描述。默认值为空字符串。

  • N：表示转发规则的序号。取值范围：1～20。

  • 多条描述间使用 & 分隔。

描述信息须满足以下要求：

  • 不能超过 255 个字符。

  • 必须以英文字母或汉字开头。

  • 只能包含英文字母、汉字、数字、空格和以下特殊字符,._=-，。。

test

RuleConditions

参数类型是否必选参数说明示例值

Rules.N.RuleConditions.N.Type

String

是

转发条件的类型。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发条件的序号。取值范围：1~10。

转发条件类型的取值范围：

  • Host：域名。

  • Path：路径。

  • Header：HTTP 标头。

Rules.1.RuleConditions.1.Type=Host

Rules.N.RuleConditions.N.HostConfigStruct否域名配置，具体可参见 HostConfig。-
Rules.N.RuleConditions.N.PathConfigStruct否路径配置，具体可参见 PathConfig。-
Rules.N.RuleConditions.N.HeaderConfigStruct否HTTP 标头配置，具体可参见 HeaderConfig。-

HostConfig

参数类型是否必选参数说明示例值

Rules.N.RuleConditions.N.HostConfig.Values.N

Array

否

域名。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发条件的序号。取值范围：1~10。

  • N^3：表示域名的序号。取值范围：1~10。

  • 多个域名之间使用 & 分隔。当您指定多个域名时，这些域名之间是“或”的关系。

基本输入规范：

  • 只能包含英文字母、数字和以下特殊字符：. - _ *。

  • 须至少包含一个半角句号（.），但不能以半角句号（.）作为开头和结尾。

  • 最多允许 128 个字符。

  • 域名大小写不敏感。

域名类型：

  • 精确域名：须符合域名规范。

  • 泛域名

    • 星号（*）可以代替 1 个或多个字符。

    • 星号（*）必须在域名开头或结尾。

    • 一个域名中最多只能包含一个星号（*）。

    • 星号（*）前后不能有除了半角句号（.）以外的字符。

域名示例：

  • 合法域名示例：www.test.com、*.com、www.test.*。

  • 非法域名示例： *aaa.com、www.*.com。

Rules.1.RuleConditions.1.HostConfig.Values.1=www.test.com

PathConfig

参数类型是否必选参数说明示例值

Rules.N.RuleConditions.N.PathConfig.Values.N

Array

否

路径。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发条件的序号。取值范围：1~10。

  • N^3：表示路径的序号。取值范围：1 ～ 10。

  • 多条路径间使用 & 分隔。当您指定多条路径时，这些路径之间是“或”的关系。

仅支持绝对路径。ALB 允许您指定精确路径或使用正则表达式来指定路径。如需使用正则表达式来指定路径，请提交工单进行申请。
指定的路径须满足以下要求：

  • 精确路径：

    • 必须以正斜线（/）开头。

    • 只能包含英文字母、数字和以下特殊字符：- _ / . % ? # &＝。正斜线（/）不能连用。

    • 最多允许 128 个字符。

  • 正则表达式：

    • 必须以波浪号（~）开头，且波浪号（~）只能出现一次。

    • 仅允许包含英文字母、数字和以下特殊字符：. - _ / ＝ ? ~ ^ * $ : ( ) [ ] +

    • ~ 开头表示区分大小写。~* 开头表示不区分大小写。

    • 最多允许 128 个字符。

Rules.1.RuleConditions.1.PathConfig.Values.1=/foo

。

HeaderConfig

参数

类型

是否必选

参数说明

示例值

Rules.N.RuleConditions.N.HeaderConfig.Key

String

否

HTTP 标头的键。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发条件的序号。取值范围：1~10

  • N^3：表示键的序号。取值范围：1~10

同一条转发规则内，键不能相同。指定的键需满足以下要求：

  • 只能包含英文字母、数字、连字符（-）和下划线（_）。

  • 不能为 Cookie 和 Host。

  • 最多允许 40 个字符。

Rules.1.RuleConditions.1.HeaderConfig.Key=test

Rules.N.RuleConditions.N.HeaderConfig.Values.N

Array

否

HTTP 标头的值。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发条件的序号。取值范围：1~10

  • N^3：表示值的序号。取值范围：1~10

每个键可以对应多个值，这些值之间是“或”的关系。指定的值需满足以下要求：

  • 允许可打印的 ASCII 字符（ASCII 码值范围：32~126）。

  • 不能以空格作为开头和结尾。

  • 最多允许 128 个字符。

Rules.1.RuleConditions.1.HeaderConfig.Values.1=test

RuleActions

参数

类型

是否必选

参数说明

示例值

Rules.N.RuleActions.N.Type

String

否

转发动作的类型。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发动作的序号。取值范围：1～5。

取值范围：

  • ForwardGroup：转发至。ALB 将请求转发至您指定的后端服务器组。

  • Redirect：重定向至。ALB 对请求进行重定向。

  • Rewrite：重写。ALB 改写请求路径，向后端服务器请求新路径下的内容。

  • TrafficLimit: 限速。当请求数量超过配置的 QPS 时，ALB 会拒绝超出限制的请求。

注意事项：

  • “限速”和“重写”转发动作必须和“转发至”转发动作配合使用。

  • “限速”、“重写”和“转发至”三者也可以配合使用。当多个转发动作组合配置时，这些转发动作之间是“且”的关系。

  • 当您需要配置“限速”时，须将“限速”配置为第一个转发动作。

Rules.1.RuleActions.1.Type=ForwardGroup

Rules.N.RuleActions.N.ForwardGroupConfigStruct否“转发至”转发动作的配置，具体可参见ForwardGroupConfig。-
Rules.N.RuleActions.N.RedirectConfigStruct否“重定向至”转发动作的配置，具体可参见RedirectConfig。-
Rules.N.RuleActions.N.RewriteConfigStruct否“重写”转发动作的配置，具体可参见RewriteConfig。-
Rules.N.RuleActions.N.TrafficLimitConfigStruct否“限速”转发动作的配置，具体可参见TrafficLimitConfig。-

ForwardGroupConfig

参数

类型

是否必选

参数说明

示例值

Rules.N.RuleActions.N.ForwardGroupConfig.ServerGroupTuples.N.ServerGroupId

String

否

请求被转发到的后端服务器组的 ID。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发动作的序号。取值范围：1～5。

  • N^3：表示服务器组的序号。取值范围：1～5。

Rules.1.RuleActions.1.ForwardGroupConfig.ServerGroupTuples.1.ServerGroupId=sg-xxx

Rules.N.RuleActions.N.ForwardGroupConfig.ServerGroupTuples.N.Weight

Integer

否

后端服务器组的权重。取值范围：0~100。当服务器组数量为 1，且未指定此参数时，参数值会被置为 100。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发动作的序号。取值范围：1～5。

  • N^3：表示服务器组的序号。取值范围：1～5。

Rules.1.RuleActions.1.ForwardGroupConfig.ServerGroupTuples.1.Weight=100

Rules.N.RuleActions.N.ForwardGroupConfig.ServerGroupStickySession.Enabled

String

否

是否开启组间会话保持。取值范围：

  • on：开启。

  • off（默认值）：不开启。

Rules.1.RuleActions.1.ForwardGroupConfig.ServerGroupStickySession.Enabled=on

Rules.N.RuleActions.N.ForwardGroupConfig.ServerGroupStickySession.Timeout

Integer

否

组间会话保持的超时时间。取值范围：1 ~ 86400。默认值：1000。单位：秒。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发动作的序号。取值范围：1～5。

Rules.1.RuleActions.1.ForwardGroupConfig.ServerGroupStickySession.Timeout=1000

RedirectConfig

参数

类型

是否必选

参数说明

示例值

Rules.N.RuleActions.N.RedirectConfig.Host

String

否

请求被重定向到的域名。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发动作的序号。 取值范围：1~5。

指定的域名须满足以下要求：

  • 只能包含英文字母、数字、半角句号（.）和连字符（-）。

  • 须至少包含一个半角句号（.），但不能以半角句号（.）作为开头和结尾。

  • 域名的每一级开头和结尾不能是连字符（-）。

  • 最多允许 128 个字符。

  • 必须是符合域名规范的精确域名，例如 www.test.com。

如果您不指定域名，重定向到的域名与请求的域名相同。

Rules.1.RuleActions.1.RedirectConfig.Host=www.test.com

Rules.N.RuleActions.N.RedirectConfig.HttpCode

Integer

否

状态码，用于表示重定向的响应。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发动作的序号。取值范围：1~5。

取值范围：

  • 301（默认值）

  • 302

  • 307

  • 308

Rules.1.RuleActions.1.RedirectConfig.HttpCode=302

Rules.N.RuleActions.N.RedirectConfig.Path

String

否

请求被重定向到的路径。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发动作的序号。 取值范围：1~5。

指定的路径须满足以下要求：

  • 必须以正斜线（/）开头。

  • 最多允许 128 个字符。

  • 只能包含英文字母、数字和以下特殊字符：- _ / . % ? # &＝。正斜线（/）不能连用。

如果您不指定路径，重定向到的路径与请求的路径相同。

Rules.1.RuleActions.1.RedirectConfig.Path=/test

Rules.N.RuleActions.N.RedirectConfig.Port

Integer

否

请求被重定向到的端口。取值范围：1~65535。

  • N^1：表示转发规则的序号。取值范围：1 ～ 10000。

  • N^2：表示转发动作的序号。取值范围：1~5。

如果您不指定端口，重定向到的端口与请求的端口相同。

Rules.1.RuleActions.1.RedirectConfig.Port=443

Rules.N.RuleActions.N.RedirectConfig.Protocol

String

否

重定向使用的协议。

  • N^1：表示转发规则的序号。取值范围：1～10000。

  • N^2：表示转发动作的序号， 取值范围：1~5。

取值范围：

  • HTTP

  • HTTPS（默认值）

Rules.1.RuleActions.1.RedirectConfig.Protocol=HTTPS

RewriteConfig

参数

类型

是否必选

参数说明

示例值

Rules.N.RuleActions.N.RewriteConfig.Path

String

否

重写后的路径。

  • N^1：表示转发规则的序号。取值范围：1 ～ 10000。

  • N^2：表示转发动作的序号。 取值范围：1~5。

指定的路径须满足以下要求：

  • 路径长度不能超过 128 个字符。

  • 路径必须以正斜线（ / ）开头。

  • 路径中只能包含英文字母、数字和以下特殊字符：- _ / . % ? # &＝。正斜线（/）不能连用。

  • 如果您在转发条件的路径中使用了正则表达式并使用半角圆括号( )创建了捕获组，您可以在转发动作的路径中使用${1}、${2}、${3}等变量来引用捕获到的内容。举例：假设转发条件中指定的路径为/volc/(.*)/(.*)/aaa，转发动作中指定的路径为/${1}/${2}。当请求的路径为/volc/ccc/bbb/aaa时，该路径将被替换为/ccc/bbb。

Rules.1.RuleActions.1.RewriteConfig.Path=/test

TrafficLimitConfig

参数

类型

是否必选

参数说明

示例值

Rules.N.RuleActions.N.TrafficLimitConfig.QPS

Integer

否

限速 QPS（每秒请求数）。取值范围：100～150000。

  • N^1：表示转发规则的序号。取值范围：1 ～ 10000。

  • N^2：表示转发动作的序号。 取值范围：1~5。

注意事项：
“限速”转发动作必须搭配“转发至”转发动作使用。当您需要配置“限速”时，须将“限速”配置为第一个转发动作。

Rules.1.RuleActions.1.TrafficLimitConfig.QPS=100

返回参数

参数类型参数说明示例值
RequestIdString请求 ID。20210811152539010225146063030****

请求示例

基础版

GET /?Action=ModifyRules&ListenerId=lsn-1g0puwcx****g8ibuxxw2pmf7&Rules.1.RuleId=rule-3ciy****tdjb46c6rrt4jszkd&Rules.1.ServerGroupId=rsp-3ciyn****piww6c6rrsz73tzn&Rules.N.Description=test&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

标准版

GET /?Action=ModifyRules&Version=2020-04-01&ListenerId=lsn-2jh19vydarjls2jrn9ki5****&Rules.1.RuleId=rule-2jgm3185koohs2jrn9kpn****&Rules.1.RuleConditions.1.Type=Host&Rules.1.RuleConditions.1.HostConfig.Values.1=www.example.com&Rules.1.RuleActions.1.Type=ForwardGroup&Rules.1.RuleActions.1.ForwardGroupConfig.ServerGroupTuples.1.ServerGroupID=rsp-r1s8yili3sow3dvb46l6****&Rules.1.RuleActions.1.ForwardGroupConfig.ServerGroupTuples.1.Weight=100&Rules.1.Priority=30 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021081318382****22524314705F6BEBE",
        "Action": "ModifyRules",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20210813183821****2524314705F6BEBE"
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code错误码错误信息错误描述
400InvalidIndexOrder.MalformedThe specified index order is malformed.指定的索引顺序参数格式不合法。

400

OperationDenied.AccountArrears

The request on the specified resource is denied due to the account being in arrears status.

因账号处于欠费状态，对于该资源的操作请求被拒绝。

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules。

400LimitExceed.RuleYou've reached the limit on the number of rules that you can operate at a time.已达到单次可操作的转发规则的数量上限。
400InvalidRules.TrafficLimitEnabled.MalformedThe specified Rules.TrafficLimitEnabled is malformed.指定的 Rules.TrafficLimitEnabled 参数格式不合法。
400InvalidRules.TrafficLimitQPS.MalformedThe specified Rules.TrafficLimitQPS is malformed.指定的 Rules.TrafficLimitQPS 参数格式不合法。
400InvalidRules.RuleId.DuplicatedThe specified Rules.RuleId is duplicated.指定的 Rules.RuleId 重复。
400InvalidRules.Description.MalformedThe specified Rules.Description is malformed.指定的 Rules.Description 参数格式不合法。

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

InvalidVpcForServerGroup.LoadBalancerMismatch

The specified VPC of ServerGroup and LoadBalancer do not match.

指定的服务器组和 ALB 实例的 VPC 不匹配。

400InvalidServerGroup.InvalidStatusThe specified ServerGroup is not in the correct status for the request.指定的服务器组所处状态无法响应该请求。
400InvalidRules.RedirectConfig.MalformedThe specified Rules.RedirectConfig is malformed.指定的 Rules.RedirectConfig 参数格式不合法。重定向协议与监听器协议一致，域名、端口、URI 至少填写一项。
400InvalidRules.RedirectConfig.RedirectHttpCode.MalformedThe specified Rules.RedirectConfig.RedirectHttpCode is malformed.指定的 Rules.RedirectConfig.RedirectHttpCode 参数格式不合法。
400InvalidRules.RedirectConfig.RedirectProtocol.MalformedThe specified Rules.RedirectConfig.RedirectProtocol is malformed.指定的 Rules.RedirectConfig.RedirectProtocol 参数格式不合法。
400InvalidRules.RedirectConfig.RedirectDomain.MalformedThe specified Rules.RedirectConfig.RedirectDomain is malformed.指定的 Rules.RedirectConfig.RedirectDomain 参数格式不合法。
400InvalidRules.RedirectConfig.RedirectUri.MalformedThe specified Rules.RedirectConfig.RedirectUri is malformed.指定的 Rules.RedirectConfig.RedirectUri 参数格式不合法。
400InvalidRules.RedirectConfig.RedirectPort.MalformedThe specified Rules.RedirectConfig.RedirectPort is malformed.指定的 Rules.RedirectConfig.RedirectPort 参数格式不合法。
400InvalidRules.RuleAction.MalformedThe specified Rules.RuleAction is malformed.指定的 Rules.RuleAction 参数格式不合法。
400InvalidRules.RewriteEnabled.MalformedThe specified Rules.RewriteEnabled is malformed.指定的 Rules.RewriteEnabled 参数格式不合法。
400InvalidRules.RewriteConfig.RewritePath.MalformedThe specified Rules.RewriteConfig.RewritePath is malformed.指定的 Rules.RewriteConfig.RewritePath 参数格式不合法。

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.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

InvalidLoadBalancer.InvalidStatus

The related LoadBalancer is not in the correct status for the request.

关联的 ALB 实例所处状态无法响应该请求。

400

InvalidServerGroup.InvalidStatus

The specified ServerGroup is not in the correct status for the request.

指定的服务器组所处状态无法响应该请求。

400OperationDenied.RewriteEnabledInRedirectActionThe request on the specified Rule is denied due to the rewrite config is not allowed to be configured in redirect action.因重定向转发动作不支持重写功能，对于该转发规则的操作请求被拒绝。
400LimitExceed.ServerGroupTupleYou've reached the limit on the number of server group tuples that you can associate with the rule.已达到单个转发规则可关联的服务器组的数量上限。
400InvalidRules.ForwardGroupConfig.ServerGroupTuples.ServerGroupId.DuplicatedThe specified Rules.ForwardGroupConfig.ServerGroupTuples.ServerGroupId is duplicated.指定的Rules.ForwardGroupConfig.ServerGroupTuples.ServerGroupId重复。
400InvalidRules.ForwardGroupConfig.MalformedEither ForwardGroupConfig or ServerGroupID must be specified转发规则中 ForwardGroupConfig、ServerGroupID 至少填写一项

400

InvalidRules.ForwardGroupConfig.StickySessionTimeout.Malformed

The specified Rules.ForwardGroupConfig.StickySessionTimeout is malformed.

指定的 Rules.ForwardGroupConfig.StickySessionTimeout 参数格式不合法。

400InvalidRules.ForwardGroupConfig.ServerGroupTuples.Weight.MalformedThe specified Rules.ForwardGroupConfig.ServerGroupTuples.Weight is malformed.指定的 Rules.ForwardGroupConfig.ServerGroupTuples.Weight 参数格式不合法。
400InvalidRules.ForwardGroupConfig.StickySessionEnabled.MalformedThe specified Rules.ForwardGroupConfig.StickySessionEnabled is malformed.指定的 Rules.ForwardGroupConfig.StickySessionEnabled 参数格式不合法。

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules.ForwardGroupConfig.ServerGroupTuples.ServerGroupId'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules.ForwardGroupConfig.ServerGroupTuples.ServerGroupId。

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules.ForwardGroupConfig.ServerGroupTuples'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules.ForwardGroupConfig.ServerGroupTuples。

403ForbiddenYou are not authorized to configure server group tuples.您无权限使用多服务器组功能。
403ForbiddenYou are not authorized to configure traffic limit for rule.您无权限对指定转发规则配置限速值。
403ForbiddenYou are not authorized to perform operations on the default rule.您无权限对默认转发规则进行操作。
403ForbiddenYou are not authorized to configure rewrite for rule.您无权限对指定转发规则配置重写。
404InvalidListener.NotFoundThe specified Listener does not exist.指定的监听器不存在。
404InvalidRule.NotFoundThe specified Rule does not exist.指定的转发规则不存在。
404InvalidServerGroup.NotFoundThe specified ServerGroup does not exist.指定的服务器组不存在。
500InternalErrorAn internal error has occurred.发生内部错误。请稍后重试或联系工程师进一步咨询。

400

InvalidTypeOfRule.LoadBalancerEditionMismatch

The type of Rule and LoadBalancer edition do not match.

转发规则类型与实例版本不匹配。

400InvalidRules.Priority.MalformedThe specified Rules.Priority is malformed.指定的 Rules.Priority 参数格式不合法。
400InvalidRules.Priority.DuplicatedThe specified Rules.Priority is duplicated.指定的 Rules.Priority 重复。
400InvalidPriorityOrder.MalformedThe specified priority order is malformed.指定的优先级顺序参数格式不合法。
400MissingParameterThe request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules.RuleConditions'.该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules.RuleConditions。
400LimitExceed.Rules.ConditionsYou've reached the limit on the number of conditions you can associate with the rule.已达到单个转发规则可添加的转发条件数量上限。
400MissingParameterThe request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules.RuleActions'.该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules.RuleActions。
400MissingParameterThe request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules.RuleConditions.HostConfig.Values'.该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules.RuleConditions.HostConfig.Values。
400MissingParameterThe request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules.RuleConditions.PathConfig.Values'.该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules.RuleConditions.PathConfig.Values。
400MissingParameterThe request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules.RuleConditions.HeaderConfig.Values'.该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules.RuleConditions.HeaderConfig.Values。
400LimitExceed.Rules.ConditionsYou've reached the limit on the number of conditions you can associate with the rule.已达到单个转发规则可添加的转发条件数量上限。
400LimitExceed.Rules.ActionsYou've reached the limit on the number of actions you can associate with the rule.已达到单个转发规则可添加的转发动作数量上限。
400LimitExceed.Rules.WildcardYou've reached the limit on the number of wildcard characters you can use in the rule.已达到单个转发规则可使用的通配符数量上限。
400InvalidRules.RuleConditions.HeaderConfig.Key.MalformedThe specified Rules.RuleConditions.HeaderConfig.Key is malformed.指定的 Rules.RuleConditions.HeaderConfig.Key 参数格式不合法。
400InvalidRules.RuleConditions.HeaderConfig.Values.MalformedThe specified Rules.RuleConditions.HeaderConfig.Values is malformed.指定的 Rules.RuleConditions.HeaderConfig.Values 参数格式不合法。
400InvalidRules.RuleActions.Type.MalformedThe specified Rules.RuleActions.Type is malformed.指定的 Rules.RuleActions.Type 参数格式不合法。
400InvalidRules.RuleConditions.Type.MalformedThe specified Rules.RuleConditions.Type is malformed.指定的 Rules.RuleConditions.Type 参数格式不合法。
400InvalidRules.RuleActions.TrafficLimitConfig.QPS.MalformedThe specified Rules.RuleActions.TrafficLimitConfig.QPS is malformed.指定的 Rules.RuleActions.TrafficLimitConfig.QPS 参数格式不合法。
400InvalidRules.RuleConditions.HostConfig.Values.MalformedThe specified Rules.RuleConditions.HostConfig.Values is malformed.指定的 Rules.RuleConditions.HostConfig.Values 参数格式不合法。
400InvalidRules.RuleConditions.PathConfig.Values.MalformedThe specified Rules.RuleConditions.PathConfig.Values is malformed.指定的 Rules.RuleConditions.PathConfig.Values 参数格式不合法。
400InvalidRules.RuleActions.RedirectConfig.MalformedThe specified Rules.RuleActions.RedirectConfig is malformed.指定的 Rules.RuleActions.RedirectConfig 参数格式不合法。重定向协议与监听器协议一致，域名、端口、URI 至少填写一项
400InvalidRules.RuleActions.RedirectConfig.Host.MalformedThe specified Rules.RuleActions.RedirectConfig.Host is malformed.指定的 Rules.RuleActions.RedirectConfig.Host 参数格式不合法。
400InvalidRules.RuleActions.RedirectConfig.Path.MalformedThe specified Rules.RuleActions.RedirectConfig.Path is malformed.指定的 Rules.RuleActions.RedirectConfig.Path 参数格式不合法。
400InvalidRules.RuleActions.RedirectConfig.Port.MalformedThe specified Rules.RuleActions.RedirectConfig.Port is malformed.指定的 Rules.RuleActions.RedirectConfig.Port 参数格式不合法。
400InvalidRules.RuleActions.RedirectConfig.HttpCode.MalformedThe specified Rules.RuleActions.RedirectConfig.HttpCode is malformed.指定的 Rules.RuleActions.RedirectConfig.HttpCode 参数格式不合法。
400InvalidRules.RuleActions.RedirectConfig.Protocol.MalformedThe specified Rules.RuleActions.RedirectConfig.Protocol is malformed.指定的 Rules.RuleActions.RedirectConfig.Protocol 参数格式不合法。
400InvalidRules.RuleActions.RewriteConfig.Path.MalformedThe specified Rules.RuleActions.RewriteConfig.Path is malformed.指定的 Rules.RuleActions.RewriteConfig.Path 参数格式不合法。

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.ForwardGroupConfig.ServerGroupStickySession.Timeout.Malformed

The specified Rules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Timeout is malformed.

指定的 Rules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Timeout 参数格式不合法。

400

InvalidRules.RuleActions.ForwardGroupConfig.ServerGroupTuples.Weight.Malformed

The specified Rules.RuleActions.ForwardGroupConfig.ServerGroupTuples.Weight is malformed.

指定的 Rules.RuleActions.ForwardGroupConfig.ServerGroupTuples.Weight 参数格式不合法。

400

InvalidRules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Enabled.Malformed

The specified Rules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Enabled is malformed.

指定的 Rules.RuleActions.ForwardGroupConfig.ServerGroupStickySession.Enabled 参数格式不合法。

400MissingParameterThe request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules.RuleActions.ForwardGroupConfig.ServerGroupTuples.ServerGroupId'.该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules.RuleActions.ForwardGroupConfig.ServerGroupTuples.ServerGroupId。
400InvalidRules.RuleActions.ForwardGroupConfig.ServerGroupTuples.ServerGroupId.DuplicatedThe specified Rules.RuleActions.ForwardGroupConfig.ServerGroupTuples.ServerGroupId is duplicated.指定的服务器组 ID 重复。
400MissingParameterThe request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'Rules.RuleActions.ForwardGroupConfig.ServerGroupTuples.ServerGroupTuples.ServerGroupId'.该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: Rules.RuleActions.ForwardGroupConfig.ServerGroupTuples。
400InvalidRules.RuleConditions.HostConfig.DuplicatedThe specified Rules.RuleConditions.HostConfig is duplicated.指定的Rules.RuleConditions.HostConfig重复。
400InvalidRules.RuleConditions.PathConfig.DuplicatedThe specified Rules.RuleConditions.PathConfig is duplicated.指定的Rules.RuleConditions.PathConfig重复。
400InvalidRules.RuleActions.RewriteConfig.DuplicatedThe specified Rules.RuleActions.RewriteConfig is duplicated.指定的Rules.RuleActions.RewriteConfig重复。
400InvalidRules.RuleActions.TrafficLimitConfig.DuplicatedThe specified Rules.RuleActions.TrafficLimitConfig is duplicated.指定的Rules.RuleActions.TrafficLimitConfig重复。
400InvalidRules.RuleConditions.HostConfig.Values.DuplicatedThe specified Rules.RuleConditions.HostConfig.Values is duplicated.指定的Rules.RuleConditions.HostConfig.Values重复。
400InvalidRules.RuleConditions.PathConfig.Values.DuplicatedThe specified Rules.RuleConditions.PathConfig.Values is duplicated.指定的Rules.RuleConditions.PathConfig.Values重复。
400InvalidRules.RuleConditions.HeaderConfig.Key.DuplicatedThe specified Rules.RuleConditions.HeaderConfig.Key is duplicated.指定的Rules.RuleConditions.HeaderConfig.Key重复。
400InvalidRules.RuleConditions.HeaderConfig.Values.DuplicatedThe specified Rules.RuleConditions.HeaderConfig.Values is duplicated.指定的Rules.RuleConditions.HeaderConfig.Values重复。
400OperationDenied.MissingForwardActionThe request on the specified Rule is denied due to the forward-type action does not exist.因转发规则，对于该缺少转发类转发动作的操作请求被拒绝。

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.MultipleForwardActions

The request on the specified Rule is denied due to multiple forward actions.

因转发规则，对于该一条转发规则包含多个转发类动作的操作请求被拒绝。

400

InvalidPriority.RuleActionMismatch

The specified priority and action of rule do not match.The traffic-limit-type rule action must have the first priority.

指定的转发动作和优先级不匹配。限速
类转发动作的优先级必须放在最前。

400InvalidPriority.RuleActionMismatchThe specified priority and action of rule do not match.The forward-type rule action must have the last priority.指定的转发动作和优先级不匹配。转发类转发动作的优先级必须放在最后。

403

Forbidden

You are not authorized to use ServerGroup with the protocol of gRPC.

您无权限使用 gRPC 协议的服务器组。