API 文档

规则关联目标组

最近更新时间:2020-07-13 08:19:09

1. 接口描述

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

本接口(AssociateTargetGroups)用来将目标组绑定到负载均衡的监听器(四层协议)或转发规则(七层协议)上。 本接口为异步接口,本接口返回成功后需以返回的 RequestID 为入参,调用 DescribeTaskStatus 接口查询本次任务是否成功。

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AssociateTargetGroups。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
Associations.N Array of TargetGroupAssociation 绑定的关系数组

3. 输出参数

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

4. 示例

示例1 七层转发规则绑定目标组

输入示例

https://clb.tencentcloudapi.com/?Action=AssociateTargetGroups
&Associations.0.LoadBalancerId=lb-phbx2420
&Associations.0.ListenerId=lbl-m2q6sp9m
&Associations.0.LocationId=loc-jjqr0ric
&Associations.0.TargetGroupId=lbtg-5xunivs0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "dd2f3116-421c-4eda-8401-b9ddefcc65d5"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误
LimitExceeded 超过配额限制
UnauthorizedOperation 未授权操作
目录