负载均衡修改目标组属性

1. 接口描述

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

修改目标组的名称或者默认端口属性

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyTargetGroupAttribute。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表。
TargetGroupId	是	String	目标组的ID。示例值：lbtg-815iz538
TargetGroupName	否	String	目标组的新名称。示例值：xxxxholic
Port	否	Integer	目标组的新默认端口。全监听目标组不支持此参数。示例值：22
ScheduleAlgorithm	否	String	调度算法，仅V2新版目标组，且后端转发协议为(HTTP\|HTTPS\|GRPC)时该参数有效。可选值： <ur> WRR:按权重轮询。 LEAST_CONN:最小连接数。 IP_HASH:按IP哈希。默认为 WRR。 <ur> 示例值：LEAST_CONN
HealthCheck	否	TargetGroupHealthCheck	健康检查详情。
Weight	否	Integer	后端服务默认权重, 其中：取值范围[0, 100] 设置该值后，添加后端服务到目标组时，若后端服务不单独设置权重，则使用这里的默认权重。 v1目标组类型不支持设置Weight参数。示例值：100
KeepaliveEnable	否	Boolean	是否开启长连接，此参数仅适用于HTTP/HTTPS目标组，true:关闭；false:开启，默认关闭。示例值：true
SessionExpireTime	否	Integer	会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。TCP/UDP目标组不支持该参数。示例值：30

3. 输出参数

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

4. 示例

示例1 修改目标组名称

修改目标组名称

输入示例

POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTargetGroupAttribute
<公共请求参数>

{
    "TargetGroupId": "lbtg-815iz538",
    "TargetGroupName": "xxxxholic"
}

输出示例

{
    "Response": {
        "RequestId": "73d80971-512f-400e-9c73-c0c135c04871"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

修改目标组属性

本页目录：