PrevNext
search by keyword

Recent Pages

Documentation
Cloud Load Balancer
    Documentation
    Download PDF

    DescribeTargetGroupInstances

    Last updated: 2022-01-07 17:25:03
    Download PDF

    1. API Description

    Domain name for API request: clb.tencentcloudapi.com.

    This API is used to get the information of servers bound to a 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 parameter. The value used for this API: DescribeTargetGroupInstances.
    Version Yes String Common parameter. The value used for this API: 2018-03-17.
    Region Yes String Common parameter. 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 in current query
    TargetGroupInstanceSet Array of TargetGroupBackend Information of the bound server
    RealCount Integer Actual statistics, which are not affected by Limit, Offset, and CAM.
    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

    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.
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy