网关负载均衡购买网关负载均衡实例-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： gwlb.tencentcloudapi.com 。

本接口(CreateGatewayLoadBalancer)用来创建网关负载均衡实例。为了使用网关负载均衡服务，您必须购买一个或多个网关负载均衡实例。成功调用该接口后，会返回网关负载均衡实例的唯一 ID。
注意：单个账号在每个地域的默认购买配额为：10个。
本接口为异步接口，接口成功返回后，可使用 DescribeGatewayLoadBalancers 接口查询负载均衡实例的状态（如创建中、正常），以确定是否创建成功。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateGatewayLoadBalancer。
Version	是	String	公共参数，本接口取值：2024-09-06。
Region	是	String	公共参数，详见产品支持的地域列表。
VpcId	是	String	网关负载均衡后端目标设备所属的私有网络 ID，如vpc-12345678，可以通过 DescribeVpcEx 接口获取。不填此参数则默认为DefaultVPC。创建内网负载均衡实例时，此参数必填。示例值：vpc-30xq****
SubnetId	是	String	网关负载均衡后端目标设备所属的私有网络的子网ID。示例值：subnet-xxx
LoadBalancerName	否	String	网关负载均衡实例名称。可支持输入1-60个字符。不填写时默认自动生成。示例值：gwlb-xxx
Number	否	Integer	创建网关负载均衡的个数，默认值为 1。批量创建数量最大支持10个。示例值：1
Tags.N	否	Array of TagInfo	购买网关负载均衡的同时，给负载均衡打上标签，最大支持20个标签键值对。
LBChargeType	否	String	网关负载均衡实例计费类型，当前只支持传POSTPAID_BY_HOUR，默认是POSTPAID_BY_HOUR。示例值：POSTPAID_BY_HOUR

3. 输出参数

参数名称	类型	描述
LoadBalancerIds	Array of String	由网关负载均衡实例唯一 ID 组成的数组。存在某些场景，如创建出现延迟时，此字段可能返回为空；此时可以根据接口返回的RequestId或DealName参数，通过DescribeTaskStatus接口查询创建的资源ID。注意：此字段可能返回 null，表示取不到有效值。示例值：["gwlb-6efswuxa"]
DealName	String	订单号。注意：此字段可能返回 null，表示取不到有效值。示例值：2022XXXX
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建一个网关负载均衡实例

在私有网络中创建一个网关负载均衡

输入示例

POST / HTTP/1.1
Host: gwlb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateGatewayLoadBalancer
<公共请求参数>

{
    "VpcId": "vpc-30xq****",
    "SubnetId": "subnet-****",
    "LoadBalancerName": "test"
}

输出示例

{
    "Response": {
        "LoadBalancerIds": [
            "gwlb-kmfr****"
        ],
        "DealName": "20211230660009761735781",
        "RequestId": "7ffa6830-cd1b-4bc4-8e24-1688885f594a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.FormatError	InvalidParameter.FormatError
InvalidParameterValue.Length	InvalidParameterValue.Length

购买网关负载均衡实例

本页目录：