购买负载均衡实例

最近更新时间:2019-03-07 23:49:45

1. 接口描述

接口请求域名: clb.tencentcloudapi.com 。

CreateLoadBalancer 接口用来创建负载均衡实例。为了使用负载均衡服务,您必须要购买一个或者多个负载均衡实例。通过成功调用该接口,会返回负载均衡实例的唯一 ID。用户可以购买的负载均衡实例类型分为:公网(应用型)、内网(应用型)。可以参考产品说明的产品类型。 本接口成功返回后,可使用查询负载均衡实例列表接口DescribeLoadBalancers查询负载均衡实例的状态,以确定是否创建成功。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateLoadBalancer
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,详见产品支持的地域列表
LoadBalancerType String 负载均衡实例的网络类型:
OPEN:公网属性, INTERNAL:内网属性。
Forward Integer 负载均衡实例。1:应用型,0:传统型,默认为应用型负载均衡实例。
LoadBalancerName String 负载均衡实例的名称,只用来创建一个的时候生效。规则:1-50 个英文、汉字、数字、连接线“-”或下划线“_”。
注意:如果名称与系统中已有负载均衡实例的名称重复的话,则系统将会自动生成此次创建的负载均衡实例的名称。
VpcId String 负载均衡后端实例所属网络 ID,可以通过 DescribeVpcEx 接口获取。 不填则默认为基础网络。
SubnetId String 在私有网络内购买内网负载均衡实例的时候需要指定子网 ID,内网负载均衡实例的 VIP 将从这个子网中产生。其他情况不用填写该字段。
ProjectId Integer 负载均衡实例所属的项目 ID,可以通过 DescribeProject 接口获取。不填则属于默认项目。

3. 输出参数

参数名称 类型 描述
LoadBalancerIds Array of String 由负载均衡实例统一 ID 组成的数组。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建一个公网应用型LB实例

输入示例

https://clb.tencentcloudapi.com/?Action=CreateLoadBalancer
&LoadBalancerType=OPEN
&Forward=1
&LoadBalancerName=test
&ProjectId=0
&<公共请求参数>

输出示例

{
    "Response": {
        "LoadBalancerIds": [
            "lb-6efswuxa"
        ],
        "RequestId": "9b3f0b57-fb64-4918-8dd6-ce02604fb52c"
    }
}

示例2 创建一个内网应用型LB实例

输入示例

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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误
LimitExceeded 超过配额限制
ResourceInsufficient 资源不足
UnauthorizedOperation 未授权操作