tencent cloud

Cloud Load Balancer

ModifyTargetGroupAttribute

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-06-17 17:26:23

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. Naming rule: 1-80 English letters, Chinese characters and other internationally compatible language characters, digits, connecting line "-", underscore "_" and other common characters (Unicode supplementary characters such as emoji and rare Chinese characters are forbidden).

Port No Integer

New default port of target group. Full listen target group does not support this parameter.

ScheduleAlgorithm No String

Scheduling algorithm. This parameter is valid only for new version V2 target groups with backend forwarding protocol (HTTP

HealthCheck No TargetGroupHealthCheck

Health check details.

Weight No Integer

Default weight of the 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 individually, use the default weight here.
  • Weight parameter settings not supported for Target Group Type v1.

KeepaliveEnable No Boolean

Whether to enable long connections. This parameter is applicable only to HTTP/HTTPS target groups. true: off; false: on. Off by default.

SessionExpireTime No Integer

Session persistence time, unit: second. Available values: 30-3600, default 0, disabled. This parameter is not supported for TCP/UDP target group.

SnatEnable No Boolean

Whether SNAT (source IP replacement) is enabled, True (enabled), False (disabled). Disabled by default. Note: When SnatEnable is enabled, the client source IP will be replaced. At this point, the Pass through client source IP option is disabled, and vice versa.

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

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 Parameter value error.
UnauthorizedOperation Unauthorized operation.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백