调用CreateRules创建规则_负载均衡-阿里云帮助中心

创建多条转发规则。

接口说明

调用该接口创建转发规则时，请注意以下事项：

配置Redirect转发动作时，除了HttpCode参数外，其余参数不能都配置默认值。
同一个转发规则配置多个转发动作时，Rewrite转发动作必须配置ForwardGroup的动作类型。
CreateRules接口属于异步接口，即系统返回一个实例ID，但该多条转发规则尚未创建成功，系统后台的创建任务仍在进行。您可以调用ListRules查询多条转发规则的创建状态：
- 当多条转发规则处于Provisioning状态时，表示多条转发规则正在创建中。
- 当多条转发规则处于Available状态时，表示多条转发规则创建成功。
一条转发规则最多支持添加的条件数（RuleConditions）和动作数（RuleActions）如下：
- 条件数：基础版5条，标准版10条，WAF增强版10条。
- 动作数：基础版3条，标准版5条，WAF增强版10条。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
alb:CreateRules	Write	ALB acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId} ALB acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}	acs:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
ListenerId	string	是	应用型负载均衡实例监听ID。	lsr-bp1bpn0kn908w4nbw****
ClientToken	string	否	客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	否	是否只预检此次请求，取值： true：发送检查请求，不会创建多条转发规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回`HTTP 2xx`状态码并直接进行创建。	false
Rules	object []	是	转发规则列表。一次最多不能超过10条。
Priority	integer	是	规则优先级，取值：1~10000。值越小表示优先级越高。最多支持添加10个规则优先级。说明同一个监听内规则优先级必须唯一。	10
RuleActions	object []	是	规则动作列表。
FixedResponseConfig	object	否	固定响应内容配置。最多支持添加20个固定响应内容。
Content	string	否	返回的固定内容。最大支持存储1 KB，只支持ASCII字符。	dssacav
ContentType	string	否	返回固定内容的格式。取值： text/plain。 text/css。 text/html。 application/javascript。 application/json。	text/plain
HttpCode	string	否	返回的HTTP响应码，仅支持HTTP_2xx、HTTP_4xx、HTTP_5xx数字型字符串，x为任意数字。	HTTP_200
ForwardGroupConfig	object	否	转发组对应的配置。最多支持添加20个转发组。
ServerGroupTuples	object []	否	转发到的目的服务器组列表。
ServerGroupId	string	否	转发到的目的服务器组。	sgp-k86c1ov501id6p****
Weight	integer	否	权重。取值越大，权重越大，表示转发的访问请求更多。取值范围：0~100。目的服务器组数为1时，未指定权重时默认值为100。目的服务器组数大于1时，需要用户指定权重值。	100
ServerGroupStickySession	object	否	服务器组之间会话保持。
Enabled	boolean	否	是否开启会话保持。取值： true：开启。 false（默认值）：不开启。	false
Timeout	integer	否	超时时间。单位：秒。取值范围：1~86400。	2
InsertHeaderConfig	object	否	写入头字段配置。最多支持添加20个写入头字段。
Key	string	否	插入的头字段名称，长度为1~40个字符，支持大小写字母a~z、数字、下划线（_）和短划线（-）。InsertHeaderConfig中的头字段名称不能重复。说明不允许将头名称设置为以下字段（不区分大小写）：`slb-id`、`slb-ip`、`x-forwarded-for`、`x-forwarded-proto`、`x-forwarded-eip`、`x-forwarded-port`、`x-forwarded-client-srcport`、`connection`、`upgrade`、`content-length`、`transfer-encoding`、`keep-alive`、`te`、`host`、`cookie`、`remoteip`、`authority`。	key
Value	string	否	插入的头字段内容。 ValueType取值为SystemDefined时取值如下： ClientSrcPort：客户端端口。 ClientSrcIp：客户端IP地址。 Protocol：客户端请求的协议（HTTP或HTTPS)。 SLBId：应用型负载均衡实例ID。 SLBPort：应用型负载均衡实例监听端口。 ValueType取值为UserDefined时：您可自定义头字段内容，限制长度为1~128个字符，支持通配符星号（）、半角问号（?）和ASCII码值`ch >= 32 && ch < 127`范围内的可打印字符，开头和结尾不能为空格。 ValueType取值为ReferenceHeader*时：您可以引用请求头字段中的某一个字段，限制长度限制为1~128个字符，支持小写字母a~z、数字、短划线（-）和下划线（_）。	UserDefined
ValueType	string	否	头字段内容类型。取值： UserDefined：您自定义头字段内容。 ReferenceHeader：引用请求头中的某一个头字段内容。 SystemDefined：系统定义头字段内容。	UserDefined
Order	integer	是	转发规则动作执行的顺序，取值范围：1~50000，按值从小到大执行动作。值不能为空，不能重复。最多支持添加20个转发规则动作的顺序。	1
RedirectConfig	object	否	外部重定向配置。最多支持添加20个外部重定向。
Host	string	否	要跳转的主机地址。取值： ${host}（默认值）：取此值时不支持和其他字符拼接使用。其他取值，字符集和格式限制如下：主机名长度为3~128个字符，支持小写字母a~z、数字、短划线（-）、半角句号（.）以及通配符星号（）和半角问号（?）。主机名至少包含一个半角句号（.），且半角句号（.）不能出现在开头或结尾。最右侧的域标签只能包含字母和通配符，不能包含数字或短划线（-）。短划线（-）不能出现在其它域标签的开头或结尾。通配符星号（）和半角问号（?）可以出现在域标签l的任意位置。	www.example.com
HttpCode	string	否	跳转方式。取值：301、302、303、307或308。	301
Path	string	否	要跳转的路径。取值： ${path}（默认值）：可以引用 ${host}、${protocol}和${port}，每个变量最多出现一次。上述变量可以同时使用，也可以和下面罗列的可取值范围内的字符串拼接使用。其他取值，字符集和格式限制如下：长度为1~128个字符。必须以正斜线（/）开头，支持字母、数字和特殊字符`$-_.+/&~@:`，不支持`“%#;!()[]^,”` ，同时支持通配符星号（*）和半角问号（?）。大小写敏感。	/test
Port	string	否	要跳转的端口。 ${port}（默认值）：该取值不支持和其他字符同时使用。其他取值：1~63335。	10
Protocol	string	否	要跳转的协议。取值： ${protocol}（默认值）：取该值时不支持和其他字符拼接使用。 HTTP或HTTPS。说明 HTTPS监听仅支持跳转HTTPS协议。	HTTP
Query	string	否	要跳转的查询字符串。 ${query}（默认值）：可以引用 ${host}、${protocol}和${port}，每个变量最多出现一次。上述变量可以同时使用，也可以和下面罗列的可取值范围内的字符串拼接使用。其他取值，字符集和格式限制如下：长度为1~128个字符。支持可见字符，不支持空格和 `#[]{}\\|<>&`。如果是字母则必须是小写字母。	quert
RewriteConfig	object	否	内部重定向。最多支持添加20个内部重定向。
Host	string	否	内部跳转的目的主机地址。取值： ${host}（默认值）：该取值不支持和其他字符拼接。其他取值，字符格式限制如下：主机名长度为3~128个字符，支持小写字母a~z、数字、短划线（-）、半角句号（.）以及通配符星号（）和半角问号（?）。主机名至少包含一个半角句号（.），且半角句号（.）不能出现在开头或结尾。最右侧的域标签只能包含字母和通配符，不能包含数字或短划线（-）。短划线（-）不能出现在其它域标签的开头或结尾。通配符星号（）和半角问号（?）可以出现在域标签的任意位置。	www.example.com
Path	string	否	要跳转的路径。取值： ${path}（默认值）：可以引用 ${host}、${protocol}和${port}，每个变量最多出现一次。上述变量可以同时使用，也可以和下面罗列的可取值范围内的字符串拼接使用。其他取值，字符集和格式限制如下：长度为1~128个字符。必须以正斜线（/）开头，支持字母、数字和特殊字符`$-_.+/&~@:`，不支持`“%#;!()[]^,”` ，同时支持通配符星号（*）和半角问号（?）。大小写敏感。	/tsdf
Query	string	否	内部跳转的查询字符串。 ${query}（默认值）：可以引用 ${host}、${protocol}和${port}，每个变量最多出现一次。上述变量可以同时使用，也可以和下面罗列的可取值范围内的字符串拼接使用。其他取值，字符集和格式限制如下：长度为1~128个字符。支持可见字符，不支持空格和 `#[]{}\\|<>&`。如果是字母则必须是小写字母。	quedsa
Type	string	是	动作类型。最多支持添加11个动作类型。取值： ForwardGroup：转发至多个虚拟服务器组。 Redirect：重定向。 FixedResponse：返回固定内容。 Rewrite：重写。 InsertHeader：写入头字段。 RemoveHeaderConfig：删除头字段。 TrafficLimitConfig：流量限速。 TrafficMirrorConfig：流量镜像。 CORS：跨域。转发规则中包括的动作类型： FinalType：一个转发规则的动作中仅能有一项FinalType的动作并且最后执行，只能包含一项ForwardGroup、Redirect、或FixedResponse。 ExtType：一个转发规则可以有一项或多项此类ExtType的动作，在FinalType的动作之前执行，且需要与FinalType并存。包含多项InsertHeader或一项Rewrite。	ForwardGroup
TrafficLimitConfig	object	否	流量限速。最多支持添加20个流量限速。
QPS	integer	否	每秒请求次数。取值范围：1~100000。	100
PerIpQps	integer	否	单IP每秒请求次数。取值范围：1 ~ 100000。说明如果同时配置QPS参数，PerIpQps参数的取值必须小于QPS参数的取值。	80
TrafficMirrorConfig	object	否	流量镜像。最多支持添加20个流量镜像。
TargetType	string	否	镜像的目标类型。取值： ForwardGroupMirror：表示镜像至服务器组。 SlsMirror：表示镜像至日志服务。	ForwardGroupMirror
MirrorGroupConfig	object	否	流量镜像至服务器组。
ServerGroupTuples	object []	否	流量镜像至服务器组。
ServerGroupId	string	否	服务器组ID。	srg-00mkgijak0w4qgz9****
CorsConfig	object	否	跨域。
AllowOrigin	array	否	允许访问的来源。
	string	否	允许访问的来源。支持配置为``或配置为一个或多个value值。value的值不能为``。单个value值必须以`http://`或者`https://`开头，后面加一个正确的域名或者一级的泛域名（例如，`.test.abc.example.com`）。单个value值可以不加端口，也可以指定端口，端口范围：1~65535*。	http://example.com
AllowMethods	array	否	选择跨域访问时允许的HTTP方法。
	string	否	选择跨域访问时允许的HTTP方法。取值： GET。 POST。 PUT。 DELETE。 HEAD。 OPTIONS。 PATCH。	GET
AllowHeaders	array	否	允许跨域的Header列表。
	string	否	允许跨域的Header列表。支持配置为`*`或配置一个或多个value值，多个value值用半角逗号（,）隔开。单个value值只允许包含大小写字母、数字，不能以下划线（_）和短划线（-）开头或结尾，最大长度限制为32个字符。	test_123
ExposeHeaders	array	否	允许暴露的Header列表。
	string	否	允许暴露的Header列表。支持配置为`*`或配置一个或多个value值，多个value值用半角逗号（,）隔开。单个value值只允许包含大小写字母、数字，不能以下划线（_）和短划线（-）开头或结尾，最大长度限制为32个字符。	test_123
AllowCredentials	string	否	是否允许携带凭证信息。取值： on：是。 off：否。	on
MaxAge	long	否	预检请求在浏览器的最大缓存时间，单位：秒。取值范围：-1~172800。	1000
RuleConditions	object []	是	转发规则条件列表。
CookieConfig	object	否	Cookie配置。最多支持添加20个Cookie。
Values	object []	否	Cookie值。
Key	string	否	Cookie键。支持1~100个字符。支持可见字符和通配符星号（*）和半角问号（?），如果是字母必须为小写字母。不支持空格和`;#[]{}\\|<>&`。	test
Value	string	否	Cookie值。支持1~100个字符。支持可见字符和通配符星号（*）和半角问号（?），如果是字母必须为小写字母。不支持空格和`;#[]{}\\|<>&`。	test
HeaderConfig	object	否	头字段配置。最多支持添加20个头字段。
Key	string	否	头字段键。支持1~40个字符。支持字母a~z、数字、短划线（-）和下划线（_）。不支持Cookie和Host。	Port
Values	array	否	头字段值。
	string	否	头字段值。同一个转发规则条件内头字段值不能重复。支持1~128个字符。支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符、星号（*）和半角问号（?）。开头和结尾不能为空格。	5006
HostConfig	object	否	主机配置。最多支持添加20个主机。
Values	array	否	主机名。
	string	否	主机名。一个转发规则条件中只能有一个主机名，并且取值不能重复。主机名长度为3~128个字符，支持小写字母a~z、数字0~9、短划线（-）、半角句号（.）、星号（）和半角问号（?）。主机名至少包含一个半角句号（.），且半角句号（.）不能出现在开头或结尾。最右侧的域标签只能包含字母和通配符，不能包含数字或短划线（-）。短划线（-）不能出现在其它域标签的开头或结尾。通配符星号（）和半角问号（?）可以出现在域标签的任意位置。	www.example.com
MethodConfig	object	否	请求方法配置。最多支持添加20个请求方法。
Values	array	否	请求方法。
	string	否	请求方法。取值：HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。	PUT
PathConfig	object	否	转发路径配置。最多支持添加20个请转发路径。
Values	array	否	转发路径。
	string	否	转发路径。取值范围：长度为1~128个字符。必须以正斜线（/）开头，支持字母、数字和特殊字符`$-_.+/&~@:`，不支持`“%#;!()[]^,”` ，同时支持通配符星号（*）和半角问号（?）。大小写敏感。	/test
QueryStringConfig	object	否	查询字符串条件配置。最多支持添加20个查询字符串条件。
Values	object []	否	查询字符串条件。
Key	string	否	查询字符串键。长度为1~100个字符。支持可见字符、通配符星号（*）和半角问号（?），如果是字母则必须为小写字母。不支持空格和`#[]{}\\|<>&`。	test
Value	string	否	查询字符串值。长度为1~128个字符。支持小写字母、可见字符和通配符星号（*）和半角问号（?），不支持空格和`#[]{}\\|<>&`。	test
ResponseHeaderConfig	object	否	标头条件配置。最多支持添加20个标头条件。
Key	string	否	头字段键。长度为1~40个字符。支持字母a~z、数字、短划线（-）和下划线（_）。不支持Cookie和Host。	Port
Values	array	否	头字段值。
	string	否	头字段值。长度为1~128个字符。支持ASCII码值`ch >= 32 && ch < 127`范围内可打印字符、小写字母以及通配符星号（*）和半角问号（?）。开头和结尾不能为空格。	5006
Type	string	是	转发规则类型。最多支持添加7个转发类型。取值： Host：主机。 Path：路径。 Header：HTTP头字段。 QueryString：查询字符串。 Method：请求方法。 Cookie：Cookie。 SourceIp：源IP。	Host
SourceIpConfig	object	否	基于源IP业务流量匹配。当Type为SourceIP时必选且有效。一条转发规则中最多支持添加5条SourceIp。
Values	array	否	基于源IP业务流量匹配
	string	否	添加一个或多个IP地址或者IP地址段。一条转发规则中最多支持添加5条SourceIp。	192.168.0.0/32
RuleName	string	是	转发规则名称。最多支持添加20个转发规则名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，可包含数字，半角句号（.），下划线（_）和短划线（-）。	test
Direction	string	否	转发规则的方向。最多支持添加1个转发规则方向。取值： Request（默认值）：请求类型，对从客户端发送到ALB的报文进行条件匹配并进行相应的处理。 Response：响应类型，对从后端服务器组返回到ALB的报文进行条件匹配并进行相应的处理。说明基础版的ALB实例不支持Response类型。	Request

返回参数

名称	类型	描述	示例值
	object	创建多条转发规则。
JobId	string	异步任务ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	请求ID。	365F4154-92F6-4AE4-92F8-7FF34B540710
RuleIds	object []	转发规则列表。
RuleId	string	转发规则ID。	rule-a3x3pg1yohq3lq****
Priority	integer	转发规则优先级，取值范围：1~10000。值越小表示优先级越高。说明同一个监听内规则优先级必须唯一。	10

示例

正常返回示例

JSON格式

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "RuleIds": [
    {
      "RuleId": "rule-a3x3pg1yohq3lq****",
      "Priority": 10
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.	资源%s [%s]的状态无效。
400	OperationDenied.IpGroupCanNotUsedForMirrorAction	The operation is not allowed because of %s.	操作被拒绝，原因是%s。
400	OperationDenied.SameGroupForForwardAndMirrorAction	The operation is not allowed because of %s.	操作被拒绝，原因是%s。
400	OperationDenied.GRPCServerGroup	The operation is not allowed because of %s.	操作被拒绝，原因是%s。
400	Conflict.Priority	There is already %s having the same configuration with %s.	%s冲突，已经存在同配置的%s。
400	ResourceQuotaExceeded.LoadBalancerRulesNum	The quota of %s is exceeded for resource %s, usage %s/%s.	配额%s已超额度限制，资源是%s，目前已使用%s，配额为%s。
400	ResourceQuotaExceeded.ServerGroupAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.	配额%s已超额度限制，资源是%s，目前已使用%s，配额为%s。
400	ResourceQuotaExceeded.LoadBalancerServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.	配额%s已超额度限制，资源是%s，目前已使用%s，配额为%s。
400	ResourceQuotaExceeded.ServerAddedNum	The quota of %s is exceeded for resource %s, usage %s/%s.	配额%s已超额度限制，资源是%s，目前已使用%s，配额为%s。
400	QuotaExceeded.RuleWildcardsNum	The quota of %s is exceeded, usage %s/%s.	配额%s已超额度限制，目前已使用%s，配额为%s。
400	QuotaExceeded.RuleMatchEvaluationsNum	The quota of %s is exceeded, usage %s/%s.	配额%s已超额度限制，目前已使用%s，配额为%s。
400	QuotaExceeded.RuleActionsNum	The quota of %s is exceeded, usage %s/%s.	配额%s已超额度限制，目前已使用%s，配额为%s。
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	%s在%s和%s中不匹配。
400	Mismatch.Protocol	The %s is mismatched for %s and %s.	%s在%s和%s中不匹配。
400	OperationDenied.RewriteMissingForwardGroup	The operation is not allowed because of RewriteMissingForwardGroup.	操作被拒绝，原因是RewriteMissingForwardGroup。
404	ResourceNotFound.Listener	The specified resource %s is not found.	资源%s不存在。
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.	资源%s不存在。

访问错误中心查看更多错误码。