绑定后端机器到监听器上

最近更新时间:2024-04-03 11:13:54

我的收藏

1. 接口描述

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

RegisterTargets 接口用来将一台或多台后端服务绑定到负载均衡的监听器(或7层转发规则),在此之前您需要先行创建相关的4层监听器或7层转发规则。对于四层监听器(TCP、UDP),只需指定监听器ID即可,对于七层监听器(HTTP、HTTPS),还需通过LocationId或者Domain+Url指定转发规则。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RegisterTargets。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerId String 负载均衡实例ID。
示例值:lb-cuxw****
ListenerId String 负载均衡监听器ID。
示例值:lbl-d1ub****
Targets.N Array of Target 待绑定的后端服务列表,数组长度最大支持20。
LocationId String 转发规则的ID,当绑定后端服务到七层转发规则时,必须提供此参数或Domain+Url两者之一。
示例值:loc-fi8g****
Domain String 目标转发规则的域名,提供LocationId参数时本参数不生效。
示例值:www.qcloud.example.com
Url String 目标转发规则的URL,提供LocationId参数时本参数不生效。
示例值:/index

3. 输出参数

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

4. 示例

示例1 注册云服务器到TCP监听器上

输入示例

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

输出示例

{
    "Response": {
        "RequestId": "898b431c-2745-4b27-80f6-e6e8038a0683"
    }
}

示例2 注册云服务器到HTTP监听器的转发规则上(使用LocationId指定规则)

输入示例

https://clb.tencentcloudapi.com/?Action=RegisterTargets
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-4fbxq45k
&LocationId=loc-r2q3jd4c
&Targets.0.InstanceId=ins-dm4xtz0i
&Targets.0.Port=334
&Targets.0.Weight=10
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "d4846a22-e758-407f-a526-db3f2d37d00e"
    }
}

示例3 注册云服务器到HTTP监听器的转发规则上(使用Domain和Url指定规则)

输入示例

https://clb.tencentcloudapi.com/?Action=RegisterTargets
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-4fbxq45k
&Domain=foo.net
&Url=/bar8
&Targets.0.InstanceId=ins-dm4xtz0i
&Targets.0.Port=233
&Targets.0.Weight=10
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "11b4338f-2d00-4766-bc67-581d959b3488"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Duplicate 参数值有重复。
InvalidParameterValue.Length 参数长度错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceInsufficient 资源不足。
UnauthorizedOperation 未授权操作。