购买负载均衡实例
最近更新时间: 2026-11-06 00:13:00
1. 接口描述
接口请求域名: clb.api3.fincloud.tencent.cn。
本接口(CreateLoadBalancer)用来创建负载均衡实例(本接口只支持购买按量计费的负载均衡,包年包月的负载均衡请通过控制台购买)。为了使用负载均衡服务,您必须购买一个或多个负载均衡实例。成功调用该接口后,会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为:公网、内网。详情可参考产品说明中的产品类型。
注意:(1)指定可用区申请负载均衡、跨zone容灾;(2)一个账号在每个地域的默认购买配额为:公网100个,内网100个。
本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。
默认接口请求频率限制:20次/秒。
接口更新时间:2025-11-19 20:20:42。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreateLoadBalancer |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-17 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InternetAccessible | 否 | 是 | InternetAccessible | 网络计费模式,最大出带宽。仅对内网属性的性能容量型实例和公网属性的所有实例生效。 示例值:查看 |
| ProjectId | 否 | 是 | Int64 | 负载均衡实例所属的项目 ID,默认项目 ID 为0。 示例值: 0 |
| ExclusiveCluster | 否 | 是 | ExclusiveCluster | 独占型实例信息。若创建独占型的内网负载均衡实例,则此参数必填。 示例值:查看 |
| LocalBgp | 否 | 是 | Bool | 本地BGP标志。 示例值: true |
| Zones | 否 | 是 | Array of String | 仅适用于私有网络内网负载均衡。内网就近接入时,选择可用区下发。 示例值: ["ap-zone-3", "ap-zone-4"] |
| VpcId | 否 | 是 | String | 负载均衡后端目标设备所属的网络 ID,如vpc-12345678。 不填此参数则默认为DefaultVPC。创建内网负载均衡实例时,此参数必填。 示例值: vpc-30xq**** |
| SubnetId | 否 | 是 | String | 在私有网络内购买内网负载均衡实例的情况下,必须指定子网 ID,内网负载均衡实例的 VIP 将从这个子网中产生。创建内网负载均衡实例时,此参数必填,创建公网IPv4负载均衡实例时,不支持指定该参数。 示例值: subnet-dva8**** |
| Number | 否 | 是 | Uint64 | 创建负载均衡的个数,默认值 1。创建个数不能超过账号所能创建的最大值,默认创建最大值为20。 示例值: 1 |
| MixIpTarget | 否 | 是 | Bool | 开启IPv6FullChain负载均衡7层监听器支持混绑IPv4/IPv6目标功能。 示例值: true |
| LoadBalancerName | 否 | 是 | String | 负载均衡实例的名称,只在创建一个实例的时候才会生效。规则:1-60 个英文、汉字、数字、连接线“-”或下划线“_”。 注意:如果名称与系统中已有负载均衡实例的名称相同,则系统将会自动生成此次创建的负载均衡实例的名称。 示例值: test-cvm-bussiness |
| MasterZoneId | 否 | 是 | String | 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID, 可用区 ID 和名称均支持,例如 100001 或 ap-zone-1 注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区。 示例值: ap-zone-1 |
| IsDDos | 否 | 是 | Bool | 是否可绑定高防包。 示例值: true |
| SlaType | 否 | 是 | String | 性能容量型规格。
示例值: clb.c2.medium |
| SnatIps | 否 | 是 | Array of SnatIp | 开启绑定跨地域/跨Vpc绑定IP的功能后,创建SnatIp。 示例值:查看 |
| ClusterTag | 否 | 是 | String | Stgw独占集群的标签。 示例值: ziyan |
| DynamicVip | 否 | 是 | Bool | 创建域名化负载均衡。 示例值: true |
| AddressIPVersion | 否 | 是 | String | 仅适用于公网负载均衡。IP版本,可取值:IPV4、IPV6、IPv6FullChain,不区分大小写,默认值 IPV4。说明:取值为IPV6表示为IPV6 NAT64版本;取值为IPv6FullChain,表示为IPv6版本。 示例值: IPV4 |
| AnycastZone | 否 | 是 | String | 仅适用于公网负载均衡。Anycast的发布域,可取可用区 ZONE_A 或 ZONE_B。仅带宽非上移用户支持此参数。(已下线) 示例值: ZONE_A |
| LoadBalancerPassToTarget | 否 | 是 | Bool | Target是否放通来自CLB的流量。开启放通(true):只验证CLB上的安全组;不开启放通(false):需同时验证CLB和后端实例上的安全组。IPv6 CLB安全组默认放通,不需要传此参数。 示例值: true |
| BusinessBelong | 否 | 是 | String | 创建CLB的业务方,比如TCB。 示例值: TCB |
| SnatPro | 否 | 是 | Bool | 是否支持绑定跨地域/跨Vpc绑定IP的功能。 示例值: true |
| ZoneId | 否 | 是 | String | 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,可用区 ID 和名称均支持,指定可用区以创建负载均衡实例。如:100001 或 ap-zone-1。 示例值: ap-zone-1 |
| VipIsp | 否 | 是 | String | 仅适用于公网负载均衡。 如果不指定本参数,则默认使用BGP。 示例值: CMCC |
| ZhiTong | 否 | 是 | Bool | 是否支持直通(仅供自研用户使用)。 示例值: true |
| Vip | 否 | 是 | String | 指定VIP申请负载均衡。此参数选填,不填写此参数时自动分配VIP。IPv4和IPv6类型支持此参数,IPv6 NAT64类型不支持。 注意:当指定VIP创建内网实例、或公网IPv6 BGP实例时,若VIP不属于指定VPC子网的网段内时,会创建失败;若VIP已被占用,也会创建失败。 示例值: 139.X.X.X |
| TgwGroupName | 否 | 是 | String | Tgw独占集群标签。 示例值: FOR_TEST |
| EipAddressId | 否 | 是 | String | EIP 的唯一 ID,可以通过 [DescribeAddresses] 接口查询。形如:eip-qhx8udkc,仅适用于内网负载均衡绑定EIP。 示例值: eip-qhx8udkc |
| AccessLogTopicId | 否 | 是 | String | 七层访问日志主题ID 示例值: 9ec21ce7-a71b-4ba7-afb1-c1bd630233** |
| LoadBalancerType | 是 | 是 | String | 负载均衡实例的网络类型: OPEN:公网属性, INTERNAL:内网属性。 示例值: OPEN |
| Tags | 否 | 是 | Array of TagInfo | 购买负载均衡的同时,给负载均衡打上标签,最大支持20个标签键值对。 示例值:查看 |
| SlaveZoneId | 否 | 是 | String | 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的备可用区ID,可用区 ID 和名称均支持,例如 100001 或 ap-zone-1 注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 [DescribeResources]接口查询一个地域的主/备可用区的列表。 示例值: ap-zone-1 |
| Egress | 否 | 是 | String | 网络出口 示例值: center_egress1 |
| LBChargePrepaid | 否 | 是 | LBChargePrepaid | 负载均衡实例的预付费相关属性 示例值:查看 |
| AdvancedRoute | 否 | 是 | Bool | 是否开启七层高级路由 示例值: false |
| Forward | 否 | 是 | Int64 | 负载均衡实例的类型。1:通用的负载均衡实例,目前只支持传入1。 示例值: 1 |
| BandwidthPackageId | 否 | 是 | String | 带宽包ID,可以通过 [DescribeBandwidthPackages] 接口获取。指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE),带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例,且运营商类型非 BGP 时 ,不支持指定具体带宽包id。 示例值: bwp-pnbe**** |
| ClusterIds | 否 | 是 | Array of String | 集群ID,集群标识,在需要配置公有云独占集群或本地专有集群时使用。 示例值: ["cluster-gbo2****"] |
| ClientToken | 否 | 是 | String | 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 示例值: 23494***** |
| LBChargeType | 否 | 是 | String | 负载均衡实例计费类型,取值:POSTPAID_BY_HOUR,PREPAID,默认是POSTPAID_BY_HOUR。 示例值: POSTPAID_BY_HOUR |
| TgwSetLabels | 否 | 否 | Array of String | 私有云专用参数,申请内网clb时,可传入四层集群标签,指定四层独占集群 示例值: ["l4-label1"] |
| StgwSetLabels | 否 | 否 | Array of String | 私有云专用参数,申请内网clb时,可传入七层集群标签,指定七层独占集群 示例值: ["l7-label1"] |
| IPv6DecoupleVpc | 否 | 否 | Int64 | 是否从vpc侧申请v6地址,1表示跟vpc解耦,不从vpc侧申请地址,0表示不跟vpc解耦,从vpc侧申请地址 示例值: 0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LoadBalancerIds | Array of String | 由负载均衡实例唯一 ID 组成的数组。 示例值: ["lb-6efswuxa"] |
| DealName | String | 订单号。 示例值: 2022XXXX |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误 |
| InternalError | 内部错误 |
| UnauthorizedOperation | 未授权操作 |
| ResourceInsufficient | 资源不足 |
| LimitExceeded | 超过配额限制 |
| FailedOperation | 操作失败 |
| InvalidParameter.FormatError | 参数格式错误。 |
| InvalidParameterValue.Length | 参数长度错误。 |
| MissingParameter | 缺少参数错误。 |
| InvalidParameterValue.Range | 参数取值范围错误。 |
5. 示例
示例1 创建一个公网负载均衡实例
在私有网络中创建一个公网负载均衡
输入示例
https://clb.api3.fincloud.tencent.cn/?Action=CreateLoadBalancer
&LoadBalancerType=OPEN
&Forward=1
&VpcId=vpc-30xqxt9p
&LoadBalancerName=test
&ProjectId=0
&<Common Parameters>
输出示例
{
"Response": {
"LoadBalancerIds": [
"lb-6efswuxa"
],
"RequestId": "9b3f0b57-fb64-4918-8dd6-ce02604fb52c"
}
}
示例2 创建一个内网负载均衡实例
在私有网络中创建一个内网负载均衡
输入示例
https://clb.api3.fincloud.tencent.cn/?Action=CreateLoadBalancer
&LoadBalancerType=INTERNAL
&Forward=1
&LoadBalancerName=test_internal
&VpcId=vpc-30xqxt9p
&SubnetId=subnet-k57djpow
&<Common Parameters>
输出示例
{
"Response": {
"LoadBalancerIds": [
"lb-kmfrnqci"
],
"RequestId": "7ffa6830-cd1b-4bc4-8e24-1688885f594a"
}
}