tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCrossTargets

Last updated: 2024-09-05 19:30:02

    1. API Description

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

    Queries information of CVMs and ENIs that use cross-region binding 2.0

    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: DescribeCrossTargets.
    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.
    Limit No Integer Number of real server lists returned. Default value: 20; maximum value: 100.
    Offset No Integer Starting offset of the real server list returned. Default value: 0.
    Filters.N No Array of Filter Filter conditions to query CVMs and ENIs
  • vpc-id - String - Required: No - (Filter condition) Filter by VPC ID, such as "vpc-12345678".
  • ip - String - Required: No - (Filter condition) Filter by real server IP, such as "192.168.0.1".
  • listener-id - String - Required: No - (Filter condition) Filter by listener ID, such as "lbl-12345678".
  • location-id - String - Required: No - (Filter condition) Filter by forwarding rule ID of the layer-7 listener, such as "loc-12345678".
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of real server lists
    CrossTargetSet Array of CrossTargets Real server list
    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 information of CVMs and ENIs that use cross-region binding 2.0

    Input Example

    https://clb.tencentcloudapi.com/?Action=DescribeCrossTargets
&Offset=0
&Limit=20
&<Common request parameters>

    Output Example

    {
    "Response": {
        "CrossTargetSet": [
            {
                "LocalVpcId": "vpc-test1234",
                "VpcId": "vpc-test4321",
                "IP": "10.22.106.8",
                "VpcName": "Test",
                "EniId": "eni-test1234",
                "InstanceId": "ins-test1234",
                "InstanceName": "test",
                "Region": "ap-shanghai"
            }
        ],
        "TotalCount": 1,
        "RequestId": "7717db32-9080-4391-acd7-18f8bbd0664d"
    }
}

    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.
    InvalidParameterValue.Range Wrong parameter value range.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy