绑定后端机器到监听器上
最近更新时间: 2025-02-18 17:50:28
1. 接口描述
接口请求域名: clb.api3.fincloud.tencent.cn。
RegisterTargets 接口用来将一台或多台后端服务绑定到负载均衡的监听器(或7层转发规则),在此之前您需要先行创建相关的4层监听器或7层转发规则。对于四层监听器(TCP、UDP),只需指定监听器ID即可,对于七层监听器(HTTP、HTTPS),还需通过LocationId或者Domain+Url指定转发规则。 本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
默认接口请求频率限制:20次/秒。
接口更新时间:2020-01-10 20:37:04。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:RegisterTargets |
Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-17 |
Region | 是 | 否 | String | 公共参数,详见产品支持的地域列表(TODO) |
LoadBalancerId | 是 | 否 | String | 负载均衡实例 ID |
ListenerId | 是 | 否 | String | 负载均衡监听器 ID |
LocationId | 否 | 否 | String | 转发规则的ID,当绑定后端服务到七层转发规则时,必须提供此参数或Domain+Url两者之一 |
Domain | 否 | 否 | String | 目标转发规则的域名,提供LocationId参数时本参数不生效 |
Url | 否 | 否 | String | 目标转发规则的URL,提供LocationId参数时本参数不生效 |
Targets | 是 | 否 | Array of Target | 待绑定的后端服务列表,数组长度最大支持20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | |
InvalidParameterValue | |
InternalError | |
UnauthorizedOperation | |
ResourceInsufficient | |
LimitExceeded | |
FailedOperation | |
InvalidParameter.FormatError | |
InvalidParameterValue.Length | |
MissingParameter |