DescribeTargetGroupInstances

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: DescribeTargetGroupInstances.
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.
Filters.N	Yes	Array of Filter	Filter. Currently, only filtering by `TargetGroupId`, `BindIP`, or `InstanceId` is supported.
Limit	No	Integer	Number of displayed results. Default value: 20
Offset	No	Integer	Display offset. Default value: 0

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of results returned for the current query
TargetGroupInstanceSet	Array of TargetGroupBackend	Information of the bound server
RealCount	Integer	The actual total number of bound instances, which is not affected by the setting of `Limit`, `Offset` and the CAM permissions.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Displaying information of servers bound to a target group

Input Example

https://clb.tencentcloudapi.com/?Action=DescribeTargetGroupInstances
&Filters.0.Name=TargetGroupId
&Filters.0.Values.0=lbtg-5xunivs0
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 2,
    "TargetGroupInstanceSet": [
      {
        "TargetGroupId": "lbtg-5xunivs0",
        "Type": "CVM",
        "InstanceId": "ins-197234qt",
        "InstanceName": "Not named",
        "Port": 3333,
        "Weight": 43,
        "PublicIpAddresses": [],
        "PrivateIpAddresses": [
          "172.16.0.32"
        ],
        "EniId": null,
        "RegisteredTime": "2019-07-24 20:02:43"
      },
      {
        "TargetGroupId": "lbtg-5xunivs0",
        "Type": "CVM",
        "InstanceId": "ins-197234qt",
        "InstanceName": "Not named",
        "Port": 2222,
        "Weight": 55,
        "PublicIpAddresses": [],
        "PrivateIpAddresses": [
          "172.16.0.32"
        ],
        "EniId": null,
        "RegisteredTime": "2019-07-23 21:01:08"
      }
    ],
    "RealCount": 2,
    "RequestId": "94240d7f-8bc1-422a-81b9-5ea76d486a66"
  }
}

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.

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

tencent cloud

Tencent Cloud Partner Network

Become a Partner

International Partner Academy

Recent Pages