1. 接口描述
接口请求域名： clb.tencentcloudapi.com 。
本接口(CreateLoadBalancer)用来创建负载均衡实例。为了使用负载均衡服务，您必须购买一个或多个负载均衡实例。成功调用该接口后，会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为：公网、内网。详情可参考产品说明中的产品类型。
注意：(1)可通过 DescribeResources 接口查询一个地域是否支持创建IPv6实例；(2)一个账号在每个地域的默认购买配额为：公网100个，内网100个。
本接口为异步接口，接口成功返回后，可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态（如创建中、正常），以确定是否创建成功。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateLoadBalancer。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| LoadBalancerType | 是 | String | 负载均衡实例的网络类型： OPEN：公网属性， INTERNAL：内网属性。 示例值：OPEN |
| Forward | 否 | Integer | 负载均衡实例的类型。1：通用的负载均衡实例，目前只支持传入1。 示例值：1 |
| LoadBalancerName | 否 | String | 负载均衡实例的名称，只在创建一个实例的时候才会生效。规则：1-60 个英文、汉字、数字、连接线“-”或下划线“_”。 注意：如果名称与系统中已有负载均衡实例的名称相同，则系统将会自动生成此次创建的负载均衡实例的名称。 示例值：test-cvm-bussiness |
| VpcId | 否 | String | 负载均衡后端目标设备所属的网络 ID，如vpc-12345678，可以通过 DescribeVpcs 接口获取。 不填此参数则默认为DefaultVPC。创建内网负载均衡实例时，此参数必填。 示例值：vpc-30xq**** |
| SubnetId | 否 | String | 在私有网络内购买内网负载均衡实例的情况下，必须指定子网 ID，内网负载均衡实例的 VIP 将从这个子网中产生。创建内网负载均衡实例时，此参数必填，创建公网IPv4负载均衡实例时，不支持指定该参数。 示例值：subnet-dva8**** |
| ProjectId | 否 | Integer | 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。不填此参数则视为默认项目。 示例值：0 |
| AddressIPVersion | 否 | String | 仅适用于公网负载均衡。IP版本，可取值：IPV4、IPV6、IPv6FullChain，不区分大小写，默认值 IPV4。说明：取值为IPV6表示为IPV6 NAT64版本；取值为IPv6FullChain，表示为IPv6版本。 示例值：IPV4 |
| Number | 否 | Integer | 创建负载均衡的个数，默认值 1。 示例值：1 |
| MasterZoneId | 否 | String | 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID，例如 100001 或 ap-guangzhou-1 注：主可用区是需要承载流量的可用区，备可用区默认不承载流量，主可用区不可用时才使用备可用区。目前仅广州、上海、南京、北京、成都、深圳金融、中国香港、首尔、法兰克福、新加坡地域的 IPv4 版本的 CLB 支持主备可用区。可通过 DescribeResources 接口查询一个地域的主可用区的列表。【如果您需要体验该功能，请通过 工单申请】 示例值：ap-guangzhou-1 |
| ZoneId | 否 | String | 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID，指定可用区以创建负载均衡实例。如：ap-guangzhou-1。 示例值：ap-guangzhou-1 |
| InternetAccessible | 否 | InternetAccessible | 网络计费模式，最大出带宽。仅对内网属性的性能容量型实例和公网属性的所有实例生效。API接口购买包年包月实例还在灰度中，如您需要体验该功能，请通过 工单申请 |
| VipIsp | 否 | String | 仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型，如需体验，请联系商务经理申请。申请通过后，即可选择中国移动（CMCC）、中国联通（CUCC）或中国电信（CTCC）的运营商类型，网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 如果不指定本参数，则默认使用BGP。可通过 DescribeResources 接口查询一个地域所支持的Isp。 示例值：CMCC |
| Tags.N | 否 | Array of TagInfo | 购买负载均衡的同时，给负载均衡打上标签，最大支持20个标签键值对。 |
| Vip | 否 | String | 指定VIP申请负载均衡。此参数选填，不填写此参数时自动分配VIP。IPv4和IPv6类型支持此参数，IPv6 NAT64类型不支持。 注意：当指定VIP创建内网实例、或公网IPv6 BGP实例时，若VIP不属于指定VPC子网的网段内时，会创建失败；若VIP已被占用，也会创建失败。 示例值：139.X.X.X |
| BandwidthPackageId | 否 | String | 带宽包ID，指定此参数时，网络计费方式（InternetAccessible.InternetChargeType）只支持按带宽包计费（BANDWIDTH_PACKAGE），带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例，且运营商类型非 BGP 时 ，不支持指定具体带宽包id。 示例值：bwp-pnbe**** |
| ExclusiveCluster | 否 | ExclusiveCluster | 独占型实例信息。若创建独占型的内网负载均衡实例，则此参数必填。 |
| SlaType | 否 | String | 性能容量型规格。
示例值：clb.c2.medium |
| ClusterIds.N | 否 | Array of String | 集群ID，集群标识，在需要配置公有云独占集群或本地专有集群时使用。公有云独占集群申请请提交工单，本地专有集群请参考本地专有集群描述。 示例值：["cluster-gbo2****"] |
| ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 示例值：23494* |
| SnatPro | 否 | Boolean | 是否支持绑定跨地域/跨Vpc绑定IP的功能。 示例值：true |
| SnatIps.N | 否 | Array of SnatIp | 开启绑定跨地域/跨Vpc绑定IP的功能后，创建SnatIp。 |
| ClusterTag | 否 | String | Stgw独占集群的标签。 示例值：ziyan |
| SlaveZoneId | 否 | String | 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID，例如 100001 或 ap-guangzhou-1 注：备可用区是主可用区故障后，需要承载流量的可用区。可通过 DescribeResources 接口查询一个地域的主/备可用区的列表。【如果您需要体验该功能，请通过 工单申请】 示例值：ap-guangzhou-1 |
| EipAddressId | 否 | String | EIP 的唯一 ID，形如：eip-11112222，仅适用于内网负载均衡绑定EIP。 示例值：eip-1111**** |
| LoadBalancerPassToTarget | 否 | Boolean | Target是否放通来自CLB的流量。开启放通（true）：只验证CLB上的安全组；不开启放通（false）：需同时验证CLB和后端实例上的安全组。 示例值：true |
| DynamicVip | 否 | Boolean | 创建域名化负载均衡。 示例值：True |
| Egress | 否 | String | 网络出口 示例值：center_egress1 |
| LBChargePrepaid | 否 | LBChargePrepaid | 负载均衡实例的预付费相关属性，API接口购买包年包月实例还在灰度中，如您需要体验该功能，请通过 工单申请 |
| LBChargeType | 否 | String | 负载均衡实例计费类型，取值：POSTPAID_BY_HOUR，PREPAID，默认是POSTPAID_BY_HOUR。API接口购买包年包月实例还在灰度中，如您需要体验该功能，请通过 工单申请 示例值：POSTPAID_BY_HOUR |
| AccessLogTopicId | 否 | String | 七层访问日志主题ID 示例值：9ec21ce7-a71b-4ba7-afb1-c1bd630233** |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LoadBalancerIds | Array of String | 由负载均衡实例唯一 ID 组成的数组。 存在某些场景，如创建出现延迟时，此字段可能返回为空；此时可以根据接口返回的RequestId或DealName参数，通过DescribeTaskStatus接口查询创建的资源ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：["lb-6efswuxa"] |
| DealName | String | 订单号。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2022XXXX |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建一个公网负载均衡实例
在私有网络中创建一个公网负载均衡
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadBalancer
<公共请求参数>
{
"Forward": 1,
"ProjectId": 0,
"LoadBalancerType": "OPEN",
"VpcId": "vpc-30xqxt9p",
"LoadBalancerName": "test-open"
}输出示例
{
"Response": {
"LoadBalancerIds": [
"lb-6efswuxa"
],
"DealName": "20220101660009831340631",
"RequestId": "9b3f0b57-fb64-4918-8dd6-ce02604fb52c"
}
}示例2 创建一个内网负载均衡实例
在私有网络中创建一个内网负载均衡
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadBalancer
<公共请求参数>
{
"Forward": 1,
"SubnetId": "subnet-k57djpow",
"LoadBalancerType": "INTERNAL",
"VpcId": "vpc-30xqxt9p",
"LoadBalancerName": "test_internal"
}输出示例
{
"Response": {
"LoadBalancerIds": [
"lb-kmfrnqci"
],
"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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ClientTokenLimitExceeded | 为确保资源不泄露，保证创建的资源ID幂等性。通过ClientToken创建资源，当订单流程已结束且发货失败，或订单流程长时间未更新时，提示当前ClientToken已经超时过期。 |
| InvalidParameter.FormatError | 参数格式错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Length | 参数长度错误。 |
| InvalidParameterValue.Range | 参数取值范围错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| ResourceInsufficient | 资源不足。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |
