Release Notes
Domain name for API request: gwlb.intl.tencentcloudapi.com.
This API is used to create a GWLB instance. To use the GWLB service, you must purchase one or more GWLB instances. After this API is called successfully, a unique ID for the GWLB instance will be returned.Note: The default purchase quota for each account in each region is 10.This is an async API. After the API is called successfully, you can use the DescribeGatewayLoadBalancers API to query the status of the GWLB instance (such as creating and normal) to determine whether the creation is successful.
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: CreateGatewayLoadBalancer. |
| 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. |
| VpcId | Yes | String | ID of the VPC to which the backend target device of the GWLB belongs, such as vpc-12345678. It can be obtained through the DescribeVpcEx interface. If left blank, it defaults to DefaultVPC. This parameter is required when a private network CLB instance is created. |
| SubnetId | Yes | String | Subnet ID of the VPC to which the backend target device of the GWLB belongs. |
| LoadBalancerName | No | String | GWLB instance name. It supports input of 1 to 60 characters. If not filled in, it will be generated automatically by default. |
| Number | No | Integer | Number of GWLBs to create, with a default of 1. The maximum batch creation quantity is 10. |
| Tags.N | No | Array of TagInfo | While the GWLB is purchased, it is tagged, with a maximum of 20 tag key-value pairs. |
| LBChargeType | No | String | GWLB instance billing type, which currently supports POSTPAID_BY_HOUR only. The default is POSTPAID_BY_HOUR. |
| Parameter Name | Type | Description |
|---|---|---|
| LoadBalancerIds | Array of String | Array of unique GWLB instance IDs.In certain scenarios, for example, when there is a delay in creation, this field may return null; at this time, you can query the created resource ID through the DescribeTaskStatus API using the RequestId or DealName parameter returned by the API.Note: this field may return null, indicating that no valid values can be obtained. |
| DealName | String | Order number. Note: this field may return null, indicating that no valid values can be obtained. |
| 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 create a GWLB in a VPC.
POST / HTTP/1.1
Host: gwlb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateGatewayLoadBalancer
<common request parameters>
{
"VpcId": "vpc-30xq****",
"SubnetId": "subnet-****",
"LoadBalancerName": "test"
}{
"Response": {
"LoadBalancerIds": [
"gwlb-kmfr****"
],
"DealName": "20211230660009761735781",
"RequestId": "7ffa6830-cd1b-4bc4-8e24-1688885f594a"
}
}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 |
フィードバック