Release Notes
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.
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. |
| 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. |
This example shows you how to query a GWLB by specifying instance ID.
POST / HTTP/1.1
Host: gwlb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGatewayLoadBalancers
<common request parameters>
{
"LoadBalancerIds": [
"abc"
]
}{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 |
フィードバック