1. 接口描述
接口请求域名： ecm.tencentcloudapi.com 。
购买负载均衡实例。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateLoadBalancer。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-19。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| EcmRegion | 是 | String | ECM区域，形如ap-xian-ecm。 示例值：ap-hangzhou-ecm |
| LoadBalancerType | 是 | String | 负载均衡实例的网络类型。目前只支持传入OPEN，表示公网属性。 示例值：OPEN |
| VipIsp | 是 | String | CMCC | CTCC | CUCC，分别对应 移动 | 电信 | 联通。 示例值：CUCC |
| LoadBalancerName | 否 | String | 负载均衡实例的名称，只在创建一个实例的时候才会生效。规则：1-50 个英文、汉字、数字、连接线“-”或下划线“_”。 注意：如果名称与系统中已有负载均衡实例的名称相同，则系统将会自动生成此次创建的负载均衡实例的名称。 示例值：testname |
| VpcId | 否 | String | 负载均衡后端目标设备所属的网络 ID，如vpc-12345678。 示例值：vpc-12345678 |
| Number | 否 | Integer | 创建负载均衡的个数，默认值 1。 |
| InternetAccessible | 否 | LoadBalancerInternetAccessible | 负载均衡的带宽限制等信息。 |
| Tags.N | 否 | Array of TagInfo | 标签。 |
| SecurityGroups.N | 否 | Array of String | 安全组。 |
| AddressIPVersion | 否 | String | 仅适用于公网负载均衡。IP版本，可取值：IPV4、IPv6FullChain，默认值 IPV4。说明：取值为IPv6FullChain，表示为IPv6版本。 示例值：IPV4 |
| SubnetId | 否 | String | 在购买IPV6负载均衡实例的情况下，必须指定子网 ID, 此参数必填；IPv4实例不支持该参数。 示例值：subnet-dva8**** |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LoadBalancerIds | Array of String | 由负载均衡实例ID组成的数组 注意：此字段可能返回 null，表示取不到有效值。 示例值：["lb-mov2697v"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 购买负载均衡实例
购买负载均衡实例
输入示例
POST / HTTP/1.1
Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadBalancer
<公共请求参数>
{
"VipIsp": "CUCC",
"VpcId": "vpc-12345678",
"InternetAccessible": {
"InternetMaxBandwidthOut": "2000"
},
"LoadBalancerType": "OPEN",
"LoadBalancerName": "testname",
"EcmRegion": "ap-hangzhou-ecm"
}输出示例
{
"Response": {
"LoadBalancerIds": [
"lb-mov2697v"
],
"RequestId": "88487432-ee86-4e5d-861b-774374123f89"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.InternalOperationFailure | 内部操作错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.FormatError | 参数格式错误。 |
| InvalidParameter.InvalidDataFormat | 数据格式不正确。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidEcmRegion | 地域参数不合法。 |
| InvalidParameterValue.InvalidISPInNode | 运营商不合法。 |
| InvalidParameterValue.InvalidLoadBalancerNum | 负载均衡数量不合法。 |
| InvalidParameterValue.InvalidLoadBalancerType | 负载均衡类型不合法。 |
| InvalidParameterValue.InvalidPublicParam | 公共参数不合法。 |
| InvalidParameterValue.InvalidSubnetInZone | 该子网不存在该节点。 |
| InvalidParameterValue.Length | 参数长度错误。 |
| InvalidParameterValue.Range | 参数值不在指定范围。 |
| InvalidParameterValue.TagNumOutOfRange | 标签数量超过限制。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.LBLimitExceeded | 申请的clb超过限制。 |
| MissingParameter | 缺少参数错误。 |
| ResourceInsufficient | 资源不足。 |
| ResourcesSoldOut.LoadBalancerSoldOut | 负载均衡资源已经售罄。 |
| UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |
