tencent cloud



Last updated: 2022-09-01 15:05:32

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-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ZoneId Yes String Site ID
Offset Yes Integer Pagination parameter
Limit Yes Integer Pagination parameter
Host No String Ignore query string parameter
Fuzzy No Boolean Specifies whether the Host parameter supports fuzzy match

3. Output Parameters

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

4. Example

Example1 Obtaining a list of CLB instances

Input Example

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

    "ZoneId": "zone-xxx",
    "Offset": 0,
    "Limit": 10

Output Example

    "Response": {
        "RequestId": "xx",
        "TotalCount": 10,
        "Data": [
                "Host": "host",
                "LoadBalancingId": "lb-d21bfaf7-8d72-11ec-841d-00ff977fb3c8",
                "Origin": [],
                "OriginId": [],
                "TTL": 123,
                "Type": "type",
                "UpdateTime": "2022-02-14T08:48:03Z",
                "ZoneId": "zid",
                "Status": "online",
                "Cname": ""

5. Developer Resources


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 add permissions first.
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