修改目标组属性

Download

Focus Mode

Font Size

Last updated: 2026-05-26 23:15:19

1. 接口描述

接口请求域名： gwlb.intl.tencentcloudapi.com 。

修改目标组的名称、健康探测等属性。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyTargetGroupAttribute。
Version	是	String	公共参数，本接口取值：2024-09-06。
Region	是	String	公共参数，详见产品支持的地域列表。
TargetGroupId	是	String	目标组的ID，可以通过DescribeTargetGroups获取。
TargetGroupName	否	String	目标组的新名称。命名规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。
HealthCheck	否	TargetGroupHealthCheck	健康检查详情。
AllDeadToAlive	否	Boolean	是否支持全死全活。
RescheduleUnbindRs	否	Boolean	重新调度功能内的解绑后端服务开关，开关打开后解绑后端服务会触发重新调度。
RescheduleUnbindRsStartTime	否	Integer	解绑RS后开启重调度的时间，可配置0s-3600s，默认0s
RescheduleUnhealthy	否	Boolean	重新调度功能内的后端服务健康探测异常开关，开关打开后后端服务健康检查异常会触发重新调度。
RescheduleUnhealthyStartTime	否	Integer	后端服务健康探测异常后开启重调度的时间，可配置0s-3600s，默认0s

3. 输出参数

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

4. 示例

示例1 修改目标组名称

修改目标组名称

输入示例

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

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

输出示例

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

5. 开发者资源

SDK

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

网关负载均衡