ModifyTargetGroupAttribute

最后更新时间：2025-11-25 10:10:56

ModifyTargetGroupAttribute

最后更新时间： 2025-11-25 10:10:56

1. API Description

Domain name for API request: clb.intl.tencentcloudapi.com.

This API is used to rename a target group or modify its default port attribute.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyTargetGroupAttribute.
Version	Yes	String	Common Params. The value used for this API: 2018-03-17.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
TargetGroupId	Yes	String	Target group ID
TargetGroupName	No	String	New name of target group
Port	No	Integer	The new default port of the target group. this parameter is not supported for full listen target groups.
ScheduleAlgorithm	No	String	Scheduling algorithm. this parameter is valid only for target groups of the new version V2 when the backend forwarding protocol is HTTP, HTTPS, or GRPC. available values:. WRR: weighted round-robin. LEAST_CONN: LEAST connection. IP_HASH: based on IP HASH. default is WRR. .
HealthCheck	No	TargetGroupHealthCheck	Health check details.
Weight	No	Integer	Default Weight for backend service. among them: value ranges from 0 to 100. after setting this value, when adding a backend service to the target group, if the backend service does not set Weight separately, use the default Weight here. Weight parameter settings not supported for v1 target group type. .
KeepaliveEnable	No	Boolean	Specifies whether to enable the persistent connection feature. this parameter applies only to HTTP and HTTPS target groups. true: disable; false: enable. this feature is off by default.
SessionExpireTime	No	Integer	Specifies the session persistence time in seconds. value range: 30-3600. default: 0 (disabled). this parameter is unsupported for TCP/UDP target groups.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Renaming a target group

Renams a target group

Input Example

POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTargetGroupAttribute
<Common request parameters>

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

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameterValue	Incorrect parameter value.
UnauthorizedOperation	Unauthorized operation.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud