购买负载均衡实例
最近更新时间: 2024-10-18 10:38:29
1. 接口描述
接口请求域名： clb.api3.fincloud.tencent.cn。
本接口(CreateLoadBalancer)用来创建负载均衡实例（本接口只支持购买按量计费的负载均衡，包年包月的负载均衡请通过控制台购买）。为了使用负载均衡服务，您必须购买一个或多个负载均衡实例。成功调用该接口后，会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为：公网、内网。详情可参考产品说明中的产品类型。 注意：(1)指定可用区申请负载均衡、跨zone容灾(仅香港支持)【如果您需要体验该功能，请通过工单申请】；(2)目前只有北京、上海、广州支持IPv6；(3)一个账号在每个地域的默认购买配额为：公网100个，内网100个。 本接口为异步接口，接口成功返回后，可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态（如创建中、正常），以确定是否创建成功。
默认接口请求频率限制：20次/秒。
接口更新时间：2024-02-22 11:26:37。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateLoadBalancer |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-17 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| LoadBalancerType | 是 | 否 | String | 负载均衡实例的网络类型：<br>OPEN：公网属性， INTERNAL：内网属性。 |
| Forward | 否 | 否 | Int64 | 负载均衡实例的类型。1：通用的负载均衡实例，目前只支持传入1 |
| LoadBalancerName | 否 | 否 | String | 负载均衡实例的名称，只在创建一个实例的时候才会生效。规则：1-50 个英文、汉字、数字、连接线“-”或下划线“_”。<br>注意：如果名称与系统中已有负载均衡实例的名称相同，则系统将会自动生成此次创建的负载均衡实例的名称。 |
| VpcId | 否 | 否 | String | 负载均衡后端目标设备所属的网络 ID，如vpc-12345678，可以通过 DescribeVpcEx 接口获取。 不传此参数则默认为基础网络（"0"）。 |
| SubnetId | 否 | 否 | String | 在私有网络内购买内网负载均衡实例的情况下，必须指定子网 ID，内网负载均衡实例的 VIP 将从这个子网中产生。 |
| ProjectId | 否 | 否 | Int64 | 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。不传此参数则视为默认项目。 |
| AddressIPVersion | 否 | 否 | String | 仅适用于公网负载均衡。IP版本，可取值：IPV4、IPV6、IPv6FullChain，默认值 IPV4。 |
| Number | 否 | 否 | Uint64 | 创建负载均衡的个数，默认值 1。 |
| MasterZoneId | 否 | 否 | String | 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID，例如 100001 或 ap-guangzhou-1<br>注：主可用区是需要承载流量的可用区，备可用区默认不承载流量，主可用区不可用时才使用备可用区，平台将为您自动选择最佳备可用区。可通过 DescribeMasterZones 接口查询一个地域的主可用区的列表。 |
| ZoneId | 否 | 否 | String | 仅适用于公网负载均衡。可用区ID，指定可用区以创建负载均衡实例。如：ap-guangzhou-1 |
| AnycastZone | 否 | 否 | String | 此参数对外不可见。 仅适用于公网负载均衡。Anycast的发布域，可取 ZONE_A 或 ZONE_B。仅带宽非上移用户支持此参数。（已下线） |
| InternetAccessible | 否 | 否 | InternetAccessible | 仅适用于公网负载均衡。负载均衡的网络计费模式。 |
| VipIsp | 否 | 否 | String | 仅适用于公网负载均衡。CMCC | CTCC | CUCC，分别对应 移动 | 电信 | 联通，如果不指定本参数，则默认使用BGP。可通过 DescribeSingleIsp 接口查询一个地域所支持的Isp。如果指定运营商，则网络计费式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 |
| Tags | 否 | 否 | Array of TagInfo | 购买负载均衡同时，给负载均衡打上标签 |
| ZhiTong | 否 | 否 | Bool | 此参数对外不可见。 是否支持直通（仅供自研用户使用） |
| Vip | 否 | 否 | String | 此参数对外不可见。 指定Vip申请负载均衡，必须同时指定 TgwGroupName 参数 |
| TgwGroupName | 否 | 否 | String | 此参数对外不可见。 Tgw独占集群的名称 |
| IsDDos | 否 | 否 | Bool | 此参数对外不可见。 是否可绑定高防包 |
| BandwidthPackageId | 否 | 否 | String | 此参数对外不可见。 带宽包ID，网络计费方式选择带宽包时必须指定带宽包ID |
| ExclusiveCluster | 否 | 否 | ExclusiveCluster | 此参数对外不可见。 独占集群信息 |
| SlaveZoneId | 否 | 否 | String | 仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID，例如 100001 或 ap-guangzhou-1<br>注：主可用区是需要承载流量的可用区，备可用区默认不承载流量，主可用区不可用时才使用备可用区，自动切换至备可用区。可通过 DescribeMasterZones 接口查询一个地域的主备可用区的列表。 |
| TgwSetLabels | 否 | 否 | Array of String | TCE专用参数，申请内网clb时，可传入四层集群标签，指定四层独占集群 |
| StgwSetLabels | 否 | 否 | Array of String | TCE专用参数，申请内网clb时，可传入七层集群标签，指定七层独占集群 |
| EipAddressId | 否 | 否 | String | EIP 的唯一 ID，形如：eip-11112222，仅适用于内网负载均衡绑定EIP。 |
| ClusterIds | 否 | 否 | Array of String | 本地专用集群ID |
| IPv6DecoupleVpc | 否 | 否 | Int64 | 是否从vpc侧申请v6地址，1表示跟vpc解耦，不从vpc侧申请地址 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LoadBalancerIds | String | 由负载均衡实例唯一 ID 组成的数组。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue | |
| InternalError | |
| UnauthorizedOperation | |
| ResourceInsufficient | |
| LimitExceeded | |
| FailedOperation | |
| InvalidParameter.FormatError | |
| InvalidParameterValue.Length | |
| MissingParameter | |
| InvalidParameterValue.Range |