tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeGatewayLoadBalancers

Last updated: 2024-11-18 16:41:14

1. API Description

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

This API is used to query the list of GWLB instances in a region.

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: DescribeGatewayLoadBalancers.
Version Yes String Common Params. The value used for this API: 2024-09-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
LoadBalancerIds.N No Array of String GWLB instance ID. Batch filtering is supported with a maximum of 20 instance IDs.
Limit No Integer Number of GWLB instances returned in a batch, with a default value of 20 and a maximum value of 100.
Offset No Integer Starting offset for returning the list of GWLB instances, with a default value of 0.
Filters.N No Array of Filter Filter criteria for querying the CLB details list. For each request, the maximum value of Filters is 10, and the maximum value of Filter.Values is 100.Filter.Name and Filter.Values are both required. Detailed filter criteria are as follows:- name - String - required: No - (filter criteria) filter by GWLB instance name, such as "gwlb-xxxx".- VpcId - String - required: No - (filter criteria) filter by the VPC to which the GWLB instance belongs, such as "vpc-bhqk****".
SearchKey No String Search field, for fuzzy matching of name and VIP.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of CLB instances that meet the filter criteria. This value is independent of the Limit in the input parameters.
LoadBalancerSet Array of GatewayLoadBalancer Returned GWLB instance array.
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 a GWLB by Specifying Instance ID

This example shows you how to query a GWLB by specifying instance ID.

Input Example

POST / HTTP/1.1
Host: gwlb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGatewayLoadBalancers
<common request parameters>

{
    "LoadBalancerIds": [
        "abc"
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "LoadBalancerSet": [
            {
                "LoadBalancerId": "abc",
                "LoadBalancerName": "abc",
                "Vips": [
                    "abc"
                ],
                "SubnetId": "abc",
                "Status": 1,
                "DeleteProtect": true,
                "TargetGroupId": "abc",
                "VpcId": "abc",
                "Tags": [
                    {
                        "TagKey": "abc",
                        "TagValue": "abc"
                    }
                ],
                "CreateTime": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

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
InvalidParameter.FormatError InvalidParameter.FormatError
InvalidParameterValue.Length InvalidParameterValue.Length
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy