tencent cloud

Feedback

DescribeTargetGroupList

Last updated: 2024-11-18 16:40:59

1. API Description

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

This API is used to obtain a target group list.

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: DescribeTargetGroupList.
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 array.
Filters.N No Array of Filter Filter criterion array, which supports TargetGroupVpcId and TargetGroupName.
Offset No Integer Starting display offset.
Limit No Integer Limit on the number of displayed entries. Default value: 20.

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 Obtaining the Target Group List.

This example shows you how to obtain the target group list.

Input Example

https://gwlb.intl.tencentcloudapi.com/?Action=DescribeTargetGroupList
&<common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "TargetGroupSet": [
            {
                "TargetGroupId": "abc",
                "VpcId": "abc",
                "TargetGroupName": "abc",
                "Port": 1,
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "UpdatedTime": "2020-09-22T00:00:00+00:00",
                "AssociatedRule": [
                    {
                        "LoadBalancerId": "abc",
                        "LoadBalancerName": "abc"
                    }
                ],
                "Protocol": "abc",
                "ScheduleAlgorithm": "abc",
                "HealthCheck": {
                    "HealthSwitch": true,
                    "Protocol": "abc",
                    "Port": 0,
                    "Timeout": 0,
                    "IntervalTime": 0,
                    "HealthNum": 0,
                    "UnHealthNum": 0
                },
                "AllDeadToAlive": true,
                "AssociatedRuleCount": 0
            }
        ],
        "RequestId": "abc"
    }
}

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
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.FormatError InvalidParameter.FormatError
InvalidParameterValue Invalid parameter value.
UnauthorizedOperation Unauthorized operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support