调用UpdateRuleAttribute接口更新转发规则属性,如条件、动作、名称等。
使用说明
- UpdateRuleAttribute接口属于异步接口,即系统返回一个请求ID,但该转发规则属性尚未更新成功,系统后台的更新任务仍在进行。您可以调用ListRules查询转发规则属性的更新状态:
- 当转发规则属性处于Configuring状态时,表示转发规则属性正在更新中。
- 当转发规则属性处于Available状态时,表示转发规则属性更新成功。
- 一条转发规则最多支持添加的条件数(RuleConditions)和动作数(RuleActions)如下:
- 条件数:基础版5条、标准版10条、WAF增强版10条。
- 动作数:基础版3条,标准版5条、WAF增强版5条。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateRuleAttribute | 要执行的操作。 取值:UpdateRuleAttribute。 |
RuleId | String | 是 | rule-4dp5i6ea**** | 转发规则ID。 |
ClientToken | String | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 | 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。 |
DryRun | Boolean | 否 | false | 是否只预检此次请求,取值:
|
RuleConditions.N.CookieConfig.Values.N.Key | String | 否 | test | Cookie键。长度为1~100个字符,支持小写字母、可见字符、星号(*)和半角问号(?),不支持空格和 |
RuleConditions.N.CookieConfig.Values.N.Value | String | 否 | test | Cookie值。长度为1~128个字符,支持小写英文字母、可见字符、星号(*)和半角问号(?),不支持空格和 |
RuleConditions.N.HeaderConfig.Key | String | 否 | Port | 头字段键。长度为1~40个字符,支持字母、数字、短划线(-)和下划线(_),不支持Cookie和Host。 |
RuleConditions.N.HeaderConfig.Values.N | String | 否 | 5006 | 头字段值。同一个转发规则条件内头字段值不能重复。命名规则:
|
RuleConditions.N.HostConfig.Values.N | String | 否 | www.example.com | 主机名。命名规则:
|
RuleConditions.N.MethodConfig.Values.N | String | 否 | PUT | 请求方法。 取值:HEAD、GET、POST、OPTIONS、PUT、PATCH或DELETE。 |
RuleConditions.N.PathConfig.Values.N | String | 否 | /test | 转发路径。命名规则:
|
RuleConditions.N.QueryStringConfig.Values.N.Key | String | 否 | test | 查询字符串键。长度为1~100个字符,支持小写字母、可见字符、星号(*)和半角问号(?),不支持空格和 |
RuleConditions.N.QueryStringConfig.Values.N.Value | String | 否 | test | 查询字符串值。长度为1~128个字符,支持小写字母、可见字符、星号(*)和半角问号(?),不支持空格和 |
RuleConditions.N.Type | String | 否 | Host | 转发规则类型。最多支持添加7个转发规则类型。取值:
|
RuleConditions.N.SourceIpConfig.Values.N | String | 否 | 192.168.0.0/32 | 添加一个或多个IP地址或者IP地址段。 |
RuleActions.N.FixedResponseConfig.Content | String | 否 | dssacav | 返回的固定内容。最大1 KB,只支持ASCII字符。 |
RuleActions.N.FixedResponseConfig.ContentType | String | 否 | text/plain | 返回固定内容的格式。 取值:text/plain、text/css、text/html、application/javascript或application/json。 |
RuleActions.N.FixedResponseConfig.HttpCode | String | 否 | HTTP_200 | 返回的HTTP响应码,仅支持HTTP_2xx、HTTP_4xx、HTTP_5xx数字型字符串,x为任意数字。 |
RuleActions.N.ForwardGroupConfig.ServerGroupTuples.N.ServerGroupId | String | 否 | sg--atstuj3rtoptyui**** | 转发到的目的服务器组ID。 |
RuleActions.N.ForwardGroupConfig.ServerGroupTuples.N.Weight | Integer | 否 | 30 | 权重。取值越大,权重越大,表示转发的访问请求更多。取值范围:0~100。
|
RuleActions.N.ForwardGroupConfig.ServerGroupStickySession.Enabled | Boolean | 否 | false | 是否开启会话保持。取值:
|
RuleActions.N.ForwardGroupConfig.ServerGroupStickySession.Timeout | Integer | 否 | 2 | 超时时间。单位:秒。取值范围:1~86400。 |
RuleActions.N.InsertHeaderConfig.Key | String | 否 | key | 插入的头字段名称,长度为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 。 |
RuleActions.N.InsertHeaderConfig.Value | String | 否 | UserDefined | 插入的头字段内容。
|
RuleActions.N.InsertHeaderConfig.ValueType | String | 否 | UserDefined | 头字段内容类型。取值:
|
RuleActions.N.Order | Integer | 否 | 1 | 转发规则动作执行的顺序,取值范围:1~50000,按值从小到大执行动作。值不能为空,不能重复。最多支持添加20个转发规则动作执行的顺序。 |
RuleActions.N.RedirectConfig.Host | String | 否 | www.example.com | 要跳转的主机地址。取值:
|
RuleActions.N.RedirectConfig.HttpCode | String | 否 | 301 | 跳转方式,取值为301、302、303、307或308。 |
RuleActions.N.RedirectConfig.Path | String | 否 | /test | 要跳转的路径。取值:
|
RuleActions.N.RedirectConfig.Port | String | 否 | 10 | 要跳转的端口。取值:
|
RuleActions.N.RedirectConfig.Protocol | String | 否 | HTTP | 要跳转的协议。取值:
说明 HTTPS监听仅支持跳转HTTPS协议。 |
RuleActions.N.RedirectConfig.Query | String | 否 | quert | 要跳转的查询字符串。取值:
|
RuleActions.N.RewriteConfig.Host | String | 否 | www.example.com | 内部跳转的目的主机地址。取值:
|
RuleActions.N.RewriteConfig.Path | String | 否 | /tsdf | 要跳转的路径。取值:
|
RuleActions.N.RewriteConfig.Query | String | 否 | quedsa | 内部跳转的查询字符串。取值:
|
RuleActions.N.Type | String | 否 | ForwardGroup | 动作类型。最多支持添加11个动作类型。取值:
转发规则中包括的动作类型:
|
RuleActions.N.TrafficLimitConfig.QPS | Integer | 否 | 100 | 每秒请求次数。取值范围:1~100000。 |
RuleActions.N.TrafficLimitConfig.PerIpQps | Integer | 否 | 80 | 单IP每秒请求次数。 取值范围:1 ~ 100000。 说明 如果同时配置QPS参数,PerIpQps参数的取值必须小于QPS参数的取值。 |
RuleActions.N.TrafficMirrorConfig.TargetType | String | 否 | ForwardGroupMirror | 镜像的目标类型。取值:
|
RuleActions.N.TrafficMirrorConfig.MirrorGroupConfig.ServerGroupTuples.N.ServerGroupId | String | 否 | srg-00mkgijak0w4qgz9**** | 服务器组ID。 |
RuleActions.N.CorsConfig.AllowOrigin.N | String | 否 | http://test.com | 允许的访问来源。支持配置为
|
RuleActions.N.CorsConfig.AllowMethods.N | String | 否 | GET | 选择跨域访问时允许的HTTP方法。取值:
|
RuleActions.N.CorsConfig.AllowHeaders.N | String | 否 | test_123 | 允许跨域的Header列表。支持配置为 |
RuleActions.N.CorsConfig.ExposeHeaders.N | String | 否 | test_123 | 允许暴露的 Header 列表。支持配置为 |
RuleActions.N.CorsConfig.AllowCredentials | String | 否 | on | 是否允许携带凭证信息。取值:
|
RuleActions.N.CorsConfig.MaxAge | Long | 否 | 1000 | 预检请求在浏览器的最大缓存时间,单位:秒。 取值范围:-1~172800。 |
RuleName | String | 否 | rule-instance-test | 转发规则名称。 长度为2~128个英文或中文字符,必须以大小字母或中文开头,可包含数字,半角句号(.),下划线(_)和短划线(-)。 |
Priority | Integer | 否 | 10 | 规则优先级,取值范围:1~10000。值越小表示优先级越高。 说明 同一个监听内规则优先级必须唯一。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
JobId | String | 72dcd26b-f12d-4c27-b3af-18f6aed5**** | 异步任务ID。 |
RequestId | String | 365F5378-41F6-4AE4-92F8-7FF34B540710 | 请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=UpdateRuleAttribute
&RuleId=rule-4dp5i6ea****
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&DryRun=false
&RuleConditions=[{"CookieConfig":{"Values":[{"Key":"test","Value":"test"}]},"HeaderConfig":{"Key":"Port","Values":["5006"]},"HostConfig":{"Values":["www.example.com"]},"MethodConfig":{"Values":["PUT"]},"PathConfig":{"Values":["/test"]},"QueryStringConfig":{"Values":[{"Key":"test","Value":"test"}]},"Type":"Host","SourceIpConfig":{"Values":["192.168.0.0/32"]}}]
&RuleActions=[{"FixedResponseConfig":{"Content":"dssacav","ContentType":"text/plain","HttpCode":"HTTP_200"},"ForwardGroupConfig":{"ServerGroupTuples":[{"ServerGroupId":"sg--atstuj3rtoptyui****","Weight":30}],"ServerGroupStickySession":{"Enabled":false,"Timeout":2}},"InsertHeaderConfig":{"Key":"key","Value":"UserDefined","ValueType":"UserDefined"},"Order":1,"RedirectConfig":{"Host":"www.example.com","HttpCode":"301","Path":"/test","Port":"10","Protocol":"HTTP","Query":"quert"},"RewriteConfig":{"Host":"www.example.com","Path":"/tsdf","Query":"quedsa"},"Type":"ForwardGroup","TrafficLimitConfig":{"QPS":100,"PerIpQps":80},"TrafficMirrorConfig":{"TargetType":"ForwardGroupMirror","MirrorGroupConfig":{"ServerGroupTuples":[{"ServerGroupId":"srg-00mkgijak0w4qgz9****"}]}},"CorsConfig":{"AllowOrigin":["http://test.com"],"AllowMethods":["GET"],"AllowHeaders":["test_123"],"ExposeHeaders":["test_123"],"AllowCredentials":"on","MaxAge":1000}}]
&RuleName=rule-instance-test
&Priority=10
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateRuleAttributeResponse>
<JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
<RequestId>365F5378-41F6-4AE4-92F8-7FF34B540710</RequestId>
</UpdateRuleAttributeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"JobId" : "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId" : "365F5378-41F6-4AE4-92F8-7FF34B540710"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IncorrectStatus.Rule | 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.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.Protocol | The %s is mismatched for %s and %s. | %s在%s和%s中不匹配。 |
400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | %s在%s和%s中不匹配。 |
400 | OperationDenied.RewriteMissingForwardGroup | The operation is not allowed because of RewriteMissingForwardGroup. | 操作被拒绝,原因是RewriteMissingForwardGroup。 |
400 | ResourceInConfiguring.Listener | The specified listener is being configured, please try again later. | 资源正在变配中,请稍后重试。 |
404 | ResourceNotFound.Rule | The specified resource %s is not found. | 资源%s不存在。 |
404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. | 资源%s不存在。 |
访问错误中心查看更多错误码。