tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeTargetGroups

最后更新时间：2024-11-18 16:40:58

1. API Description

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

This API is used to query target group information.

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: DescribeTargetGroups.
Version Yes String Common Params. The value used for this API: 2024-09-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TargetGroupIds.N No Array of String Target group ID, which is mutually exclusive with Filters.
Limit No Integer Limit on the number of displayed entries. Default value: 20.
Offset No Integer Starting display offset.
Filters.N No Array of Filter Filter criterion array, which supports TargetGroupVpcId and TargetGroupName.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of displayed results.
TargetGroupSet Array of TargetGroupInfo Collection of displayed target group information.
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 Querying a Target Group by ID

This example shows you how to query a target group by ID.

Input Example

POST / HTTP/1.1
Host: gwlb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTargetGroups
<common request parameters>

{
    "TargetGroupIds": [
        "lbtg-5xunivs0"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "7ae76f16-a859-449a-a43e-674c229999cc",
        "TargetGroupSet": [
            {
                "AllDeadToAlive": false,
                "AssociatedRule": [
                    {
                        "LoadBalancerId": "gwlb-poqv7z4y",
                        "LoadBalancerName": "test-gwlb-2"
                    }
                ],
                "CreatedTime": "2024-09-04T14:30:45+08:00",
                "HealthCheck": {
                    "HealthNum": 3,
                    "HealthSwitch": true,
                    "IntervalTime": 5,
                    "Port": 0,
                    "Protocol": "icmp",
                    "Timeout": 2,
                    "UnHealthNum": 3
                },
                "Port": 6081,
                "Protocol": "geneve",
                "ScheduleAlgorithm": "ip_hash_3",
                "TargetGroupId": "lbtg-5xunivs0",
                "TargetGroupName": "gwlb-tar-5",
                "UpdatedTime": "2024-09-04T14:30:44+08:00",
                "VpcId": "vpc-drpj1tv1"
            }
        ],
        "TotalCount": 1
    }
}

Example2 Querying Target Group Information by Criteria

This example shows you how to query target group information by criteria.

Input Example

POST / HTTP/1.1
Host: gwlb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTargetGroups
<common request parameters>

{
    "Filters": [
        {
            "Values": [
                "vpc-drpj1tv1"
            ],
            "Name": "TargetGroupVpcId"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "7ae76f16-a859-449a-a43e-674c229999cc",
        "TargetGroupSet": [
            {
                "AllDeadToAlive": false,
                "AssociatedRule": [
                    {
                        "LoadBalancerId": "gwlb-poqv7z4y",
                        "LoadBalancerName": "test-gwlb-2"
                    }
                ],
                "CreatedTime": "2024-09-04T14:30:45+08:00",
                "HealthCheck": {
                    "HealthNum": 3,
                    "HealthSwitch": true,
                    "IntervalTime": 5,
                    "Port": 0,
                    "Protocol": "icmp",
                    "Timeout": 2,
                    "UnHealthNum": 3
                },
                "Port": 6081,
                "Protocol": "geneve",
                "ScheduleAlgorithm": "ip_hash_3",
                "TargetGroupId": "lbtg-5xunivs0",
                "TargetGroupName": "gwlb-tar-5",
                "UpdatedTime": "2024-09-04T14:30:44+08:00",
                "VpcId": "vpc-drpj1tv1"
            }
        ],
        "TotalCount": 1
    }
}

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 Invalid parameter value.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款