1. 接口描述
接口请求域名: alb.tencentcloudapi.com 。
ModifyLoadBalancerAttributes接口属于异步接口,即系统返回一个请求ID,但该应用型负载均衡实例属性尚未修改成功,系统后台的修改任务仍在进行。您可以调用DescribeLoadBalancerDetail查询应用型负载均衡实例属性的修改状态:
- 当应用型负载均衡实例属性处于Configuring状态时,表示应用型负载均衡实例属性正在修改中。
- 当应用型负载均衡实例属性处于Active状态时,表示应用型负载均衡实例属性修改成功。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyLoadBalancerAttributes。 |
| Version | 是 | String | 公共参数,本接口取值:2025-10-30。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| LoadBalancerId | 是 | String | 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。 示例值:alb-f8q2xk9m |
| ClientToken | 否 | String | 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 > 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。 示例值:328980d0-b3d9-4368-96e8-1c3864bfc4b3 |
| DeletionProtection | 否 | DeletionProtectionConfig | 删除保护配置 |
| DryRun | 否 | Boolean | 是否只预检此次请求,取值: - true:发送检查请求,不会修改应用型负载均衡实例的属性。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码 DryRunOperation。- false(默认值):发送正常请求,通过检查后返回 HTTP_2xx状态码并直接进行操作。示例值:true |
| LoadBalancerName | 否 | String | 应用型负载均衡实例名称。长度为1~80个字符,可包含中文、字母、数字、短划线(-)、正斜线(/)、半角句号(.)和下划线(_)。 示例值:alb-f8q2xk9m-test |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改实例名称
输入示例
POST / HTTP/1.1
Host: alb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLoadBalancerAttributes
<公共请求参数>
{
"LoadBalancerId": "alb-f8q2xk9m",
"LoadBalancerName": "test-name"
}
输出示例
{
"Response": {
"RequestId": "ed530899-814d-4b1f-90f6-832a89458728"
}
}
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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。