点击领取2000元阿里云代金券,付款抵现金用,云服务器69元/年限时抢>>> 点击咨询成为阿里云VIP客户享永久折扣>>>
点击领取2860元腾讯云代金券,付款抵现金用,云服务器88元/年限时抢>>> 点击成为腾讯云VIP客户享永久折扣优惠>>> 点击进入华为云最新优惠活动现场>>> 点击成为华为云VIP客户享永久折扣优惠>>>
1. 接口描述
接口请求域名: clb.tencentcloudapi.com 。
本接口(CreateLoadBalancer)用来创建负载均衡实例(本接口只支持购买按量计费的负载均衡,包年包月的负载均衡请通过控制台购买)。为了使用负载均衡服务,您必须购买一个或多个负载均衡实例。成功调用该接口后,会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为:公网、内网。详情可参考产品说明中的产品类型。
注意:(1)指定可用区申请负载均衡、跨zone容灾(仅香港支持)【如果您需要体验该功能,请通过 工单申请】;(2)目前只有北京、上海、广州支持IPv6;(3)一个账号在每个地域的默认购买配额为:公网100个,内网100个。
本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态(如创建中、正常),以确定是否创建成功。
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 |
必选 |
类型 |
描述 |
Action |
是 |
String |
公共参数,本接口取值:CreateLoadBalancer。 |
Version |
是 |
String |
公共参数,本接口取值:2018-03-17。 |
Region |
是 |
String |
公共参数,详见产品支持的 地域列表。 |
LoadBalancerType |
是 |
String |
负载均衡实例的网络类型: OPEN:公网属性, INTERNAL:内网属性。 |
Forward |
否 |
Integer |
负载均衡实例的类型。1:通用的负载均衡实例,目前只支持传入1。 |
LoadBalancerName |
否 |
String |
负载均衡实例的名称,只在创建一个实例的时候才会生效。规则:1-60 个英文、汉字、数字、连接线“-”或下划线“_”。 注意:如果名称与系统中已有负载均衡实例的名称相同,则系统将会自动生成此次创建的负载均衡实例的名称。 |
VpcId |
否 |
String |
负载均衡后端目标设备所属的网络 ID,如vpc-12345678,可以通过 DescribeVpcEx 接口获取。 不传此参数则默认为基础网络("0")。 |
SubnetId |
否 |
String |
在私有网络内购买内网负载均衡实例的情况下,必须指定子网 ID,内网负载均衡实例的 VIP 将从这个子网中产生。 |
ProjectId |
否 |
Integer |
负载均衡实例所属的项目 ID,可以通过 DescribeProject 接口获取。不传此参数则视为默认项目。 |
AddressIPVersion |
否 |
String |
仅适用于公网负载均衡。IP版本,可取值:IPV4、IPV6、IPv6FullChain,默认值 IPV4。 |
Number |
否 |
Integer |
创建负载均衡的个数,默认值 1。 |
MasterZoneId |
否 |
String |
仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1 注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区,平台将为您自动选择最佳备可用区。可通过 DescribeMasterZones 接口查询一个地域的主可用区的列表。 |
ZoneId |
否 |
String |
仅适用于公网负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。 |
InternetAccessible |
否 |
InternetAccessible |
仅适用于公网负载均衡。负载均衡的网络计费模式。 |
VipIsp |
否 |
String |
仅适用于公网负载均衡。CMCC | CTCC | CUCC,分别对应 移动 | 电信 | 联通,如果不指定本参数,则默认使用BGP。可通过 DescribeSingleIsp 接口查询一个地域所支持的Isp。如果指定运营商,则网络计费式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 |
Tags.N |
否 |
Array of TagInfo |
购买负载均衡同时,给负载均衡打上标签。 |
Vip |
否 |
String |
指定Vip申请负载均衡。 |
BandwidthPackageId |
否 |
String |
带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE)。 |
ExclusiveCluster |
否 |
ExclusiveCluster |
独占集群信息。 |
ClientToken |
否 |
String |
用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 |
SnatPro |
否 |
Boolean |
是否支持绑定跨地域/跨Vpc绑定IP的功能。 |
SnatIps.N |
否 |
Array of SnatIp |
开启绑定跨地域/跨Vpc绑定IP的功能后,创建SnatIp。 |
ClusterTag |
否 |
String |
Stgw独占集群的标签。 |
SlaveZoneId |
否 |
String |
仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1 注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 DescribeMasterZones 接口查询一个地域的主/备可用区的列表。 |
EipAddressId |
否 |
String |
EIP 的唯一 ID,形如:eip-11112222,仅适用于内网负载均衡绑定EIP。 |
3. 输出参数
参数名称 |
类型 |
描述 |
LoadBalancerIds |
Array of String |
由负载均衡实例唯一 ID 组成的数组。 |
RequestId |
String |
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建一个公网负载均衡实例
在私有网络中创建一个公网负载均衡
输入示例
https://clb.tencentcloudapi.com/?Action=CreateLoadBalancer
&LoadBalancerType=OPEN
&Forward=1
&VpcId=vpc-30xqxt9p
&LoadBalancerName=test
&ProjectId=0
&<公共请求参数>
输出示例
{
"Response": {
"LoadBalancerIds": [
"lb-6efswuxa"
],
"RequestId": "9b3f0b57-fb64-4918-8dd6-ce02604fb52c"
}
}
示例2 创建一个内网负载均衡实例
在私有网络中创建一个内网负载均衡
输入示例
https://clb.tencentcloudapi.com/?Action=CreateLoadBalancer
&LoadBalancerType=INTERNAL
&Forward=1
&LoadBalancerName=test_internal
&VpcId=vpc-30xqxt9p
&SubnetId=subnet-k57djpow
&<公共请求参数>
输出示例
{
"Response": {
"LoadBalancerIds": [
"lb-kmfrnqci"
],
"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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 |
描述 |
FailedOperation |
操作失败。 |
InternalError |
内部错误。 |
InvalidParameter |
参数错误。 |
InvalidParameter.FormatError |
参数格式错误。 |
InvalidParameterValue |
参数取值错误。 |
InvalidParameterValue.Length |
参数长度错误。 |
InvalidParameterValue.Range |
参数取值范围错误。 |
LimitExceeded |
超过配额限制。 |
MissingParameter |
缺少参数错误。 |
ResourceInsufficient |
资源不足。 |
UnauthorizedOperation |
未授权操作。 |
|