AI 助理
备案控制台
文档
输入文档关键字查找
首页 负载均衡 应用型负载均衡ALB 开发参考 API参考 API目录 转发规则 UpdateRulesAttribute - 批量更新转发规则属性

UpdateRulesAttribute - 批量更新转发规则属性

更新时间：
产品详情
我的收藏

批量更新转发规则属性。

接口说明

UpdateRulesAttribute 接口属于异步接口，即系统返回一个请求 ID，但该转发规则属性尚未批量更新成功，系统后台的更新任务仍在进行。您可以调用 ListRules 查询转发规则属性的更新状态：

  • 当多条转发规则属性处于 Configuring 状态时，表示转发规则属性正在批量更新中。

  • 当多条转发规则属性处于 Available 状态时，表示转发规则属性批量更新成功。

  • 一条转发规则最多支持添加的条件数（RuleConditions）和动作数（RuleActions）如下：

    • 条件数：基础版 5 条，标准版 10 条，WAF 增强版 10 条。
    • 动作数：基础版 3 条，标准版 5 条，WAF 增强版 5 条。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ClientTokenstring否

客户端 Token，用于保证请求的幂等性。

由客户端生成该参数值，要保证在不同请求间唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-42665544***
Rulesarray<object>是

转发规则列表

object是
Priorityinteger否

转发规则优先级

RuleNamestring否

转发规则名称

RuleActionsarray<object>否

转发规则动作

object是
FixedResponseConfigobject否

返回固定内容动作配置

Contentstring否

内容

ContentTypestring否

内容类型

HttpCodestring否

HTTP 响应码

ForwardGroupConfigobject否

转发组动作配置

ServerGroupTuplesarray<object>否

转发到的目的服务器组列表

object否
ServerGroupIdstring否

服务器组标识

Weightinteger否

权重

ServerGroupStickySessionobject否

服务器组之间会话保持

Enabledboolean否

是否开启会话保持

Timeoutinteger否

超时时间

InsertHeaderConfigobject否

插入头部动作配置

CoverEnabledboolean否

是否覆盖请求中的值

Keystring否

HTTP 标头

Valuestring否

HTTP 标头内容

ValueTypestring否

取值类型

Orderinteger是

优先级

RedirectConfigobject否

重定向动作配置

Hoststring否

要跳转的主机地址

HttpCodestring否

跳转方式

Pathstring否

要跳转的路径

Portstring否

要跳转的端口

Protocolstring否

要跳转的协议

Querystring否

要跳转的查询字符串

RewriteConfigobject否

内部重定向动作配置

Hoststring否

主机名

Pathstring否

路径

Querystring否

查询

Typestring是

转发规则动作类型

TrafficLimitConfigobject否

流量限速

TrafficMirrorConfigobject否

流量镜像

TargetTypestring否

镜像目标类型

MirrorGroupConfigobject否

镜像至服务器组

RemoveHeaderConfigobject否

去除 HTTP 标头

Keystring否

HTTP 标头键

CorsConfigobject否

跨域

AllowOriginarray否

允许的访问来源

string否
AllowMethodsarray否

选择跨域访问时允许的 HTTP 方法

string否
AllowHeadersarray否

允许跨域的 Header 列表

string否
ExposeHeadersarray否

允许暴露的 Header 列表

string否
AllowCredentialsstring否

是否允许携带凭证信息

MaxAgelong否

预检请求在浏览器的最大缓存时间

RuleConditionsarray<object>否

转发规则条件

object是
CookieConfigobject否

Cookie 条件配置

Valuesarray<object>否

Cookie 键值对列表

object否
Keystring否

Cookie 条件键

Valuestring否

Cookie 条件值

HeaderConfigobject否

HTTP 标头条件配置

Keystring否

HTTP 标头键

Valuesarray否

HTTP 标头值列表

string否
HostConfigobject否

主机名条件配置

Valuesarray否

主机名列表

string否
MethodConfigobject否

HTTP 请求方法条件配置

Valuesarray否

HTTP 请求方法列表

string否
PathConfigobject否

查询字符串条件配置

Valuesarray否

路径条件列表

string否
QueryStringConfigobject否

查询字符串条件配置

Valuesarray<object>否

查询字符串条件键值对列表

object否
Keystring否

查询字符串条件键

Valuestring否

查询字符串条件值

ResponseHeaderConfigobject否

返回 HTTP 标头

Keystring否

返回 HTTP 标头键

Valuesarray否

返回 HTTP 标头值

string否
ResponseStatusCodeConfigobject否

返回状态码条件

Valuesarray否

返回状态码条件

string否
Typestring否

条件类型

SourceIpConfigobject否

基于源 IP 业务流量匹配

RuleIdstring是

转发规则 ID

DryRunboolean否

是否只预检此次请求，取值：

  • true：发送检查请求，不会批量更新转发规则属性。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。

  • false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。

false

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

365F4154-92F6-4AE4-92F8-7FF34B540710
JobIdstring

异步任务 ID。

72dcd26b-f12d-4c27-b3af-18f6aed5****

示例

正常返回示例

JSON格式

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

错误码

HTTP status code错误码错误信息描述
400OperationDenied.IpGroupCanNotUsedForMirrorActionThe operation is not allowed because of %s.操作被拒绝，原因是%s。
400IncorrectStatus.RuleThe status of %s [%s] is incorrect.转发规则的当前状态不支持本次操作。
400OperationDenied.SameGroupForForwardAndMirrorActionThe operation is not allowed because of %s.操作被拒绝，原因是%s。
400OperationDenied.GRPCServerGroupThe operation is not allowed because of %s.操作被拒绝，原因是存在绑定本GRPC服务器组的监听没有启用HTTP2.0。
400Conflict.PriorityThere is already %s having the same configuration with %s.优先级冲突，已经存在相同配置
400ResourceQuotaExceeded.ServerGroupAttachedNumThe quota of %s is exceeded for resource %s, usage %s/%s.服务器组可被关联数已超额度限制。
400ResourceQuotaExceeded.LoadBalancerServersNumThe quota of %s is exceeded for resource %s, usage %s/%s.后端服务器数已超额度限制。
400ResourceQuotaExceeded.ServerAddedNumThe quota of %s is exceeded for resource %s, usage %s/%s.服务器添加到组已超额度限制。
400QuotaExceeded.RuleWildcardsNumThe quota of %s is exceeded, usage %s/%s.配额%s已超额度限制，目前已使用%s，配额为%s。
400QuotaExceeded.RuleMatchEvaluationsNumThe quota of %s is exceeded, usage %s/%s.转发规则条件数已超额度限制。
400QuotaExceeded.RuleActionsNumThe quota of %s is exceeded, usage %s/%s.配额%s已超额度限制，目前已使用%s，配额为%s。
400Mismatch.ProtocolThe %s is mismatched for %s and %s.%s在%s和%s中不匹配。
400Mismatch.VpcIdThe %s is mismatched for %s and %s.%s在%s和%s中不匹配。
400OperationDenied.ServiceManagedResourceThe operation is not allowed because the current resource of %s is managed resource.操作被拒绝，原因是资源%s为托管资源。
400OperationDenied.ListenerIdInconsistentThe operation is not allowed because of ListenerIdInconsistent.操作被拒绝，原因是当前转发规则属于不同的监听。
400IllegalParam.PriorityThe param of Priority is illegal.参数Priority非法
400OperationDenied.MirrorActionSupportHttpGroupOnlyThe operation is not allowed because of MirrorActionSupportHttpGroupOnly.操作被拒绝，原因是流量镜像动作只支持HTTP类型的服务器组。
400OperationDenied.ProtocolMustSameForForwardGroupActionThe operation is not allowed because of ProtocolMustSameForForwardGroupAction.操作被禁止，原因：必须是相同的协议
404ResourceNotFound.RuleThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.ServerGroupThe specified resource %s is not found.后端服务器组不存在。

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

变更历史

变更时间变更内容概要操作
2024-11-28OpenAPI 错误码发生变更查看变更详情
2024-01-18OpenAPI 错误码发生变更查看变更详情
上一篇：UpdateRuleAttribute - 更新转发规则属性下一篇：ListRules - 查询转发规则
文档推荐