tencent cloud

APIs

DocumentaçãoAPIsApplication Load BalancerInstance APIsDescribeLoadBalancers

DescribeLoadBalancers

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-28 14:18:01

1. API Description

Domain name for API request: alb.intl.tencentcloudapi.com.

Query instance configuration.

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: DescribeLoadBalancers.
Version Yes String Common Params. The value used for this API: 2025-10-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Filters.N No Array of Filter

Query filter criteria, supporting the following fields

  • LoadBalancerId: Cloud Load Balancer instance ID
  • LoadBalancerName: CLB name
  • LoadBalancerStatus: load balancing status
  • VpcId: VPC ID
  • tag:tag-key: filter by tag key-value pair. Replace tag-key with the actual tag key. For example, tag:env means filtering by the tag key env.
  • AddressType: network type
    • Intranet: private network
    • Internet: public network
  • AddressIpVersion:
    • IPv4: IPv4 address
    • IPv6: IPv6 address
  • SecurityGroupId: security group ID
MaxResults No Integer

Number of entries displayed each time during a batch query. Value range: 1–100. Default value: 20.
NextToken No String

Whether there is a token for the next query. Value:

  • Not required for the first query or when there is no next query.
  • If there is a next query, the value is the NextToken returned from the last API call.

3. Output Parameters

Parameter Name Type Description
LoadBalancers Array of LoadBalancer

Application CLB instance list.
MaxResults Integer

Entry number displayed each time during batch query.
NextToken String

Whether there is a token for the next query. Value:

  • If NextToken is empty, there is no next query.
  • If NextToken has a return value, this value is the token for starting the next query.
TotalCount Integer

Number of list entries.
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 Queries the LoadBalancer list

Input Example

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

{
    "MaxResults": 1
}

Output Example

{
    "Response": {
        "LoadBalancers": [
            {
                "AddressIpVersion": "IPv4",
                "AddressType": "Internet",
                "CreateTime": "2026-05-25 18:27:42",
                "DeletionProtection": {
                    "DeletionProtectionEnabled": false,
                    "Reason": ""
                },
                "Domain": "alb-f8q2xk9m-c0rpri8t217fy3ii.gz-tencentalb.com",
                "LoadBalancerBillingConfig": {
                    "BandwidthPackageId": "bwp-q8m2x4pa",
                    "ChargeType": "POSTPAID_BY_HOUR"
                },
                "LoadBalancerId": "alb-f8q2xk9m",
                "LoadBalancerName": "alb-f8q2xk9m",
                "LoadBalancerOperationLocks": [],
                "LoadBalancerStatus": "Active",
                "ModificationProtection": {
                    "ModificationProtectionEnabled": false,
                    "OperatorUin": "",
                    "Reason": ""
                },
                "Tags": [],
                "VpcId": "vpc-92hffaxb"
            }
        ],
        "MaxResults": 1,
        "NextToken": "eyJsYXN0X3Jlc291cmNlX2lkIjogImFsYi01cWw0MHZzayIsICJsYXN0X2RiX2lkIjogNjY1MCwgInRvdGFsX2NvdW50IjogMjd9",
        "TotalCount": 27,
        "RequestId": "d635fb06-fa8a-41fe-bb34-ef1b0615364f"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Anterior: ModifyLoadBalancerAddressTypePróximo: DescribeLoadBalancerDetail

Ajuda e Suporte

Esta página foi útil?

comentários

Search
    Enter keywords to search documentation