应用型负载均衡修改转发规则属性

1. 接口描述

接口请求域名： alb.tencentcloudapi.com 。

ModifyRulesAttributes修改转发规则属性，本接口为异步接口，返回成功后需以返回的RequestID为入参，调用DescribeAsyncJobs接口查询本次任务是否成功。
一条规则最多支持10个转发条件（Conditions），5个转发动作（Actions）。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyRulesAttributes。
Version	是	String	公共参数，本接口取值：2025-10-30。
Region	是	String	公共参数，详见产品支持的地域列表。
ListenerId	是	String	监听器 ID，格式为 lst- 后接 8 位字母数字。示例值：lst-d9p3k7wa
LoadBalancerId	是	String	负载均衡实例 ID，格式为 alb- 后接 8 位字母数字。示例值：alb-f8q2xk9m
Rules.N	是	Array of RuleModify	转发规则列表。
DryRun	否	Boolean	是否只预检查此次请求。示例值：false

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改转发规则属性

输入示例

POST / HTTP/1.1
Host: alb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRulesAttributes
<公共请求参数>

{
    "ListenerId": "lst-d9p3k7wa",
    "LoadBalancerId": "alb-f8q2xk9m",
    "Rules": [
        {
            "Actions": [
                {
                    "FixedResponseConfig": {
                        "Content": "OK",
                        "ContentType": "text/html",
                        "HttpCode": 200
                    },
                    "InsertHeaderConfig": {
                        "Key": "ClientVer",
                        "Value": "1.0",
                        "ValueType": "UserDefined"
                    },
                    "Order": 1,
                    "RedirectConfig": {
                        "Host": "www.redirect.com",
                        "HttpCode": 301,
                        "Path": "/redirecturl",
                        "Port": "443",
                        "Protocol": "HTTPS",
                        "Query": "${query}"
                    },
                    "RemoveHeaderConfig": {
                        "Key": "ClientVer"
                    },
                    "RewriteConfig": {
                        "Host": "www.myhost.com",
                        "Path": "/redirecturl",
                        "Query": "${query}"
                    },
                    "TargetGroupConfig": {
                        "TargetGroupStickySession": {
                            "Enabled": false,
                            "Timeout": 1000
                        },
                        "TargetGroups": [
                            {
                                "TargetGroupId": "lbtg-0zrnc9qa",
                                "Weight": 10
                            }
                        ]
                    },
                    "Type": "TargetGroup"
                }
            ],
            "Conditions": [
                {
                    "CookieConfig": [
                        {
                            "Key": "ClientId",
                            "Value": "xea4cd"
                        }
                    ],
                    "HeaderConfig": {
                        "Key": "ClientVer",
                        "Values": [
                            "1.0",
                            "1.1"
                        ]
                    },
                    "HostConfig": [
                        "www.myhost.com"
                    ],
                    "MethodConfig": [
                        "GET"
                    ],
                    "PathConfig": [
                        "/url"
                    ],
                    "QueryStringConfig": [
                        {
                            "Key": "ClientVer",
                            "Value": "1.1"
                        }
                    ],
                    "SourceIpConfig": [
                        "192.168.1.3/32"
                    ],
                    "Type": "Host"
                }
            ],
            "Priority": 100,
            "RuleId": "rule-h8cy5gwl",
            "RuleName": "newName"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "3b848733-70e5-4558-ae39-4b9938eb7609"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
DryRunOperation	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.InvalidClientToken	ClientToken 格式无效。
InvalidParameter.InvalidFieldType	字段类型错误。
InvalidParameter.InvalidFieldValue	字段值错误。
InvalidParameter.InvalidQuotaCheckRequest	配额检查请求无效。
InvalidParameter.MissingAction	缺少 Action 参数。
InvalidParameter.MissingField	请填写必要参数。
InvalidParameterValue	参数取值错误。
LimitExceeded	超过配额限制。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
RegionError	地域错误
RequestLimitExceeded	请求的次数超过了频率限制。
ResourceInUse	资源被占用。
ResourceNotFound	资源不存在。
ResourceNotFound.Listener	监听器未找到。
ResourceNotFound.LoadBalancer	负载均衡资源不存在。
ResourceNotFound.Rule	转发规则未找到
ResourceUnavailable	资源不可用。
ResourceUnavailable.Listener	监听器处于不可用状态。
ResourceUnavailable.LoadBalancer	ALB状态不可用。
ResourceUnavailable.Rule	规则状态不可用。
ResourceUnavailable.TargetGroup	目标组处于不可用状态
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

修改转发规则属性

本页目录：