tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTargets

Last updated: 2024-09-05 19:29:07

    1. API Description

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

    This API (DescribeTargets) is used to query the list of real servers bound to some listeners of a CLB instance.

    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: DescribeTargets.
    Version Yes String Common Params. The value used for this API: 2018-03-17.
    Region No String Common Params. This parameter is not required for this API.
    LoadBalancerId Yes String CLB instance ID.
    ListenerIds.N No Array of String List of listener IDs (20 IDs at most).
    Protocol No String Listener protocol type
    Port No Integer Listener port
    Filters.N No Array of Filter Conditions for querying the list of real servers bound to the CLB. The filter criteria are as follows:
  • location-id - String - Required: No - (Filter criterion) Filter by rule ID, such as loc-12345678.
  • private-ip-address - String - Required: No - (Filter criterion) Filter by private IP address of the real server, such as 172.16.1.1.
  • tag - String - Required: No - (Filter criterion) Filter by tag, such as tag-test.
    		•

    3. Output Parameters

    Parameter Name Type Description
    Listeners Array of ListenerBackend Information of real servers bound to the listener
    Note: This field may return null, indicating that no valid values can be obtained.
    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 the Real Server List by Location

    This example shows you how to query the server list under a specific rule through filtering by location-id when the Layer-7 listener of CLB has too many rules.

    Input Example

    https://clb.tencentcloudapi.com/?Action=DescribeTargets
&LoadBalancerId=lb-12345678
&Filters.0.Name=location-id
&Filters.0.Values.0=loc-12345678
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Listeners": [
            {
                "ListenerId": "lbl-4fo6k8na",
                "Protocol": "HTTP",
                "Port": 80,
                "Rules": [
                    {
                        "LocationId": "loc-o9732aw0",
                        "Domain": "www.123.com",
                        "Url": "/",
                        "Targets": [
                            {
                                "Type": "cvm",
                                "PrivateIpAddresses": [
                                    "172.16.0.12"
                                ],
                                "EniId": "",
                                "PublicIpAddresses": null,
                                "InstanceName": "abcd1234",
                                "Port": 555,
                                "Weight": 10,
                                "InstanceId": "ins-19425y2y",
                                "RegisteredTime": "2019-07-12 16:22:02"
                            }
                        ],
                        "FunctionTargets": []
                    }
                ],
                "Targets": null
            },
            {
                "ListenerId": "lbl-4ue2rpl2",
                "Protocol": "TCP",
                "Port": 888,
                "Rules": null,
                "Targets": [
                    {
                        "Type": "cvm",
                        "PrivateIpAddresses": [
                            "172.16.0.12"
                        ],
                        "EniId": "",
                        "PublicIpAddresses": null,
                        "InstanceName": "abcd1234",
                        "Port": 666,
                        "Weight": 40,
                        "InstanceId": "ins-19425y2y",
                        "RegisteredTime": "2019-07-12 16:22:54"
                    }
                ]
            }
        ],
        "RequestId": "a5cbe92d-c7f2-41d4-8343-3cb42c3fd1dd"
    }
}

    Example2 Querying All Real Servers Bound to a CLB Instance

    This example shows you how to query all real servers bound to a CLB instance.

    Input Example

    https://clb.tencentcloudapi.com/?Action=DescribeTargets
&LoadBalancerId=lb-10iq9lou
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Listeners": [
            {
                "ListenerId": "lbl-12345678",
                "Protocol": "HTTP",
                "Port": 80,
                "Rules": [
                    {
                        "LocationId": "loc-12345678",
                        "Domain": "123.com",
                        "Url": "/",
                        "Targets": [
                            {
                                "Type": "CVM",
                                "InstanceId": "ins-12345678",
                                "Port": 80,
                                "Weight": 10,
                                "PublicIpAddresses": null,
                                "PrivateIpAddresses": [
                                    "172.16.0.100"
                                ],
                                "InstanceName": "123",
                                "RegisteredTime": "2023-01-01",
                                "EniId": "eni-12345678"
                            }
                        ],
                        "FunctionTargets": null
                    }
                ],
                "Targets": null,
                "EndPort": 0
            }
        ],
        "RequestId": "038afb75-7303-48da-abdc-e25f0cbfda0f"
    }
}

    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.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.InvalidFilter Incorrect Filter parameter.
    InvalidParameterValue.Length Wrong parameter length.
    UnauthorizedOperation Unauthorized operation.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy