接口请求域名： gwlb.intl.tencentcloudapi.com 。
本接口(CreateGatewayLoadBalancer)用来创建网关负载均衡实例。为了使用网关负载均衡服务，您必须购买一个或多个网关负载均衡实例。成功调用该接口后，会返回网关负载均衡实例的唯一 ID。
注意：单个账号在每个地域的默认购买配额为：10个。
本接口为异步接口，接口成功返回后，可使用 DescribeTaskStatus 接口查询负载均衡实例的状态。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateGatewayLoadBalancer。 |
| Version | 是 | String | 公共参数，本接口取值：2024-09-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| VpcId | 是 | String | 网关负载均衡后端目标设备所属的私有网络 ID，如vpc-azd4dt1c，可以通过 DescribeVpcs 接口获取。 |
| SubnetId | 是 | String | 网关负载均衡后端目标设备所属的私有网络的子网ID。可通过DescribeSubnets接口获取。 |
| LoadBalancerName | 否 | String | 网关负载均衡实例名称。命名规则：1-80 个英文字母、汉字等国际通用语言字符，数字，连接线“-”、下划线“_”等常见字符（禁止Unicode补充字符，如emoji表情、生僻汉字等）。不填写时默认自动生成。 |
| Number | 否 | Integer | 创建网关负载均衡的个数，默认值为 1。批量创建数量最大支持10个。 |
| Tags.N | 否 | Array of TagInfo | 购买网关负载均衡的同时，给负载均衡打上标签，最大支持20个标签键值对。 |
| LBChargeType | 否 | String | 网关负载均衡实例计费类型，当前只支持传POSTPAID_BY_HOUR（按量计费），默认是POSTPAID_BY_HOUR。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LoadBalancerIds | Array of String | 由网关负载均衡实例唯一 ID 组成的数组。 |
| DealName | String | 订单号。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
在私有网络中创建一个网关负载均衡
POST / HTTP/1.1
Host: gwlb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateGatewayLoadBalancer
<公共请求参数>
{
"VpcId": "vpc-30xq****",
"SubnetId": "subnet-****",
"LoadBalancerName": "the_name_of_gwlb"
}
{
"Response": {
"LoadBalancerIds": [
"gwlb-kmfr****"
],
"DealName": "20211230660009761735781",
"RequestId": "7ffa6830-cd1b-4bc4-8e24-1688885f594a"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.FormatError | InvalidParameter.FormatError |
| InvalidParameterValue.Length | InvalidParameterValue.Length |
文档反馈