文档平台 API 中心 负载均衡 应用型负载均衡相关接口 修改监听器绑定的后端机器的转发权重

修改监听器绑定的后端机器的转发权重

最近更新时间:2018-12-20 21:04:22

1. 接口描述

接口请求域名: clb.tencentcloudapi.com 。

ModifyTargetWeight 接口用于修改监听器绑定的后端机器的转发权重。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyTargetWeight
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,详见产品支持的地域列表
LoadBalancerId String 负载均衡实例 ID
ListenerId String 负载均衡监听器 ID
Weight Integer 后端云服务器新的转发权重,取值范围:0~100。
LocationId String 转发规则的ID,当绑定机器到七层转发规则时,必须提供此参数或Domain+Url两者之一
Domain String 目标规则的域名,提供LocationId参数时本参数不生效
Url String 目标规则的URL,提供LocationId参数时本参数不生效
Targets.N Array of Target 要修改权重的后端机器列表

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改监听器上注册的后端转发目标的权重

输入示例

https://clb.tencentcloudapi.com/?Action=ModifyTargetWeight
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-d1ubsydq
&Targets.0.InstanceId=ins-dm4xtz0i
&Targets.0.Port=334
&Weight=8
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "85c7b3e8-7fd8-4c62-8b3b-7ba52d7a1dca"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误
UnauthorizedOperation 未授权操作

如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >