tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeLoadBalancing

Last updated: 2022-11-28 16:50:36
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to obtain a list of CLB instances.

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: DescribeLoadBalancing.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Offset Yes Integer Offset for paginated queries. Default value: 0.
Limit Yes Integer Limit on paginated queries. Value range: 1-1000. Default value: 10.
Filters.N No Array of AdvancedFilter Filter criteria. Each filter criteria can have up to 20 entries.
  • zone-id:
    Filter by site ID, such as zone-1a8df68z
    Type: String
    Required: No
    Fuzzy query: Not supported
  • load-balancing-id
    Filter by load balancer ID, such as lb-d21bfaf7-8d72-11ec-841d-00ff977fb3c8
    Type: String
    Required: No
    Fuzzy query: Not supported
  • host:
    Filter by load balancing hostname, such as lb.tencent.com
    Type: String
    Required: No
    Fuzzy query: Supported (only one hostname allowed in a query)
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of records.
    Data Array of LoadBalancing Load balancer information.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Obtaining the list of load balancers of a site

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancing
<Common request parameters>

{
    "Offset": 0,
    "Limit": 10,
    "Filters": [
        {
            "Name": "zone-id",
            "Values": [
                "zone-20hzkd4rdmy0"
            ],
            "Fuzzy": false
        }
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707",
        "TotalCount": 1,
        "Data": [
            {
                "Host": "test.tencent.com",
                "LoadBalancingId": "lb-d21bfaf7-8d72-11ec-841d-00ff977fb3c8",
                "OriginGroupId": "orgin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a",
                "BackupOriginGroupId": "",
                "TTL": 600,
                "Type": "proxied",
                "UpdateTime": "2022-02-14T08:48:03Z",
                "ZoneId": "zone-20hzkd4rdmy0",
                "Status": "online",
                "Cname": "test.tencent.com.acc.edgeonedy1.com",
                "OriginType": "normal",
                "AdvancedOriginGroups": []
            }
        ]
    }
}

    Example2 Obtaining the details of a load balancer by ID

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancing
<Common request parameters>

{
    "Offset": 0,
    "Limit": 10,
    "Filters": [
        {
            "Name": "zone-id",
            "Values": [
                "zone-20hzkd4rdmy0"
            ],
            "Fuzzy": false
        },
        {
            "Name": "load-balancing-id",
            "Values": [
                "lb-d21bfaf7-8d72-11ec-841d-00ff977fb3c8"
            ],
            "Fuzzy": false
        }
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707",
        "TotalCount": 1,
        "Data": [
            {
                "Host": "test.tencent.com",
                "LoadBalancingId": "lb-d21bfaf7-8d72-11ec-841d-00ff977fb3c8",
                "OriginGroupId": "orgin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a",
                "BackupOriginGroupId": "",
                "TTL": 600,
                "Type": "proxied",
                "UpdateTime": "2022-02-14T08:48:03Z",
                "ZoneId": "zone-20hzkd4rdmy0",
                "Status": "online",
                "Cname": "test.tencent.com.acc.edgeonedy1.com",
                "OriginType": "normal",
                "AdvancedOriginGroups": []
            }
        ]
    }
}

    Example3 Obtaining the details of a load balancer by domain name in a fuzzy query

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancing
<Common request parameters>

{
    "Offset": 0,
    "Limit": 10,
    "Filters": [
        {
            "Name": "zone-id",
            "Values": [
                "zone-20hzkd4rdmy0"
            ],
            "Fuzzy": false
        },
        {
            "Name": "host",
            "Values": [
                "test"
            ],
            "Fuzzy": true
        }
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707",
        "TotalCount": 1,
        "Data": [
            {
                "Host": "test.tencent.com",
                "LoadBalancingId": "lb-d21bfaf7-8d72-11ec-841d-00ff977fb3c8",
                "OriginGroupId": "orgin-2ccgtb24-7dc5-46s2-9r3e-95825d53dwe3a",
                "BackupOriginGroupId": "",
                "TTL": 600,
                "Type": "proxied",
                "UpdateTime": "2022-02-14T08:48:03Z",
                "ZoneId": "zone-20hzkd4rdmy0",
                "Status": "online",
                "Cname": "test.tencent.com.acc.edgeonedy1.com",
                "OriginType": "normal",
                "AdvancedOriginGroups": []
            }
        ]
    }
}

    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
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    UnauthorizedOperation.NoPermission The sub-account is not authorized for the operation. Please get permissions first.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy