tencent cloud

APIs

ModifyTargetGroupAttributes

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-28 14:17:07

1. API Description

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

Modify the target group.

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: ModifyTargetGroupAttributes.
Version Yes String Common Params. The value used for this API: 2025-10-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DryRun No Boolean

Whether to preview this request.

  • false (default): Send a normal request to directly modify the target group.
  • true: Send a preview request to check whether the parameters, format, and service limits for modifying the target group meet the requirements.
HealthCheckConfig No HealthCheckConfig

Health check configuration.

KeepaliveEnabled No Boolean

Whether to enable long connections.

SchedulerAlgorithm No String

Scheduling algorithm. Values:

  • wrr: weighted polling. Real servers are selected by weight. The higher the weight, the more chances a server stands to be polled.
  • wlc: number of weighted least connections. When weight values of different real servers are the same, the server with fewer current connections stands more chances to be polled.
StickySessionConfig No StickySessionConfig

Session persistence configuration.

TargetGroupId No String

Target group ID, format: lbtg- followed by 8 alphanumeric characters.

TargetGroupName No String

Target group name. It can contain 1–255 characters, consisting of digits, upper- and lower-case letters, Chinese characters, half-width periods (.), underscores (_), and dashes (-). If no target group name is specified, the ID is used as the target group name by default.

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 Modify the target group

Input Example

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

{
    "HealthCheckConfig": {
        "HealthCheckCodes": [
            "http_1xx"
        ],
        "HealthCheckEnabled": true,
        "HealthCheckHealthyThreshold": 2,
        "HealthCheckHost": "example.com",
        "HealthCheckHttpVersion": "HTTP1.1",
        "HealthCheckInterval": 10,
        "HealthCheckMethod": "GET",
        "HealthCheckPath": "/hello/index.html",
        "HealthCheckPort": 80,
        "HealthCheckProtocol": "HTTP",
        "HealthCheckTimeout": 2,
        "HealthCheckUnhealthyThreshold": 2
    },
    "KeepaliveEnabled": true,
    "SchedulerAlgorithm": "wrr",
    "StickySessionConfig": {
        "Cookie": "SERVERID",
        "CookieTimeout": 20,
        "StickySessionEnabled": true,
        "StickySessionType": "Insert"
    },
    "TargetGroupId": "lbtg-0zrnc9qa",
    "TargetGroupName": "test-group"
}

Output Example

{
    "Response": {
        "RequestId": "3b848733-70e5-4558-ae39-4b9938eb7609"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Ajuda e Suporte

Esta página foi útil?

comentários