租户端 网络 负载均衡（CLB） 历史版本（V2接口）

购买负载均衡实例

最近更新时间: 2024-10-17 17:10:00

接口描述

CreateLoadBalancer 接口用来创建负载均衡实例。为了使用负载均衡服务，您必须要购买一个或者多个负载均衡实例。通过成功调用该接口，会返回负载均衡实例的唯一 ID。用户可以购买的负载均衡实例类型分为：公网、内网。

接口访问域名：lb.api.qcloud.com

请求参数

以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，见 公共请求参数 页面。其中，此接口的 Action 字段为 CreateLoadBalancer。

参数名称 必选 类型 描述
loadBalancerType 是 Int 负载均衡实例的网络类型：
2：公网属性， 3：内网属性。
forward 否 Int 负载均衡实例。1：应用型。
loadBalancerName 否 String 负载均衡实例的名称，只用来创建一个的时候生效。规则：1-50 个英文、汉字、数字、连接线“-”或下划线“_”。
注意：如果名称与系统中已有负载均衡实例的名称重复的话，则系统将会自动生成此次创建的负载均衡实例的名称。
domainPrefix 否 String 域名前缀。负载均衡的域名由用户输入的域名前缀与腾讯云金融专区自动生成的域名后缀一起组合而成，保证是唯一的域名。创建应用型负载均衡的时候该字段无意义。
规则：1-20 个小写英文字母、数字或连接线“-”。内网类型的负载均衡不支持该字段。
注意：如果域名前缀与系统中已有的域名前缀重复的话，则系统将会自动生成此次创建的负载均衡实例的前缀名称。例如 xxxxx.region.appId.clb.myqcloud.com，您只需要填写前缀"xxxxx"。
vpcId 否 String 负载均衡实例所属网络 ID，可以通过 DescribeVpcEx 接口获取。 不填或者填 0 则表示网络为 <基础网络>。
subnetId 否 Int 在私有网络内购买内网负载均衡实例的时候需要指定子网 ID，内网负载均衡实例的 VIP 将从这个子网中产生。其他情况不用填写该字段。
projectId 否 Int 负载均衡实例所属的项目 ID，可以通过 接口获取。不填则属于默认项目。
number 否 Int 购买负载均衡实例的个数，默认 1。
zoneId 否 Int 传递了就是申请指定AZ跨容灾的VIP，默认可不传。

返回参数

参数名称 类型 描述
code Int 公共错误码，0 表示成功，其他值表示失败。详见错误码页面的 公共错误码。
message String 模块错误信息描述，与接口相关。
codeDesc String 英文错误码，成功返回 Success，失败有相应的英文说明。
unLoadBalancerIds Array 由负载均衡实例统一 ID 组成的数组。
requestId Int 任务 ID。
dealIds Array 保留字段。

示例

购买三个负载均衡实例：

https://lb.api.qcloud.com/v2/index.php?Action=CreateLoadBalancer
&<公共请求参数>
&loadBalancerType=2
&number=3

返回：

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "requestId": 3901942,
    "dealIds": [
        "3901942"
    ],
    "unLoadBalancerIds": {
        "3901942": [
            "lb-cjcymkw9",
            "lb-fpk0oxhp",
            "lb-ikpzv02x"
        ]
    }
}

其中 lb-cjcymkw9 为刚刚购买的负载均衡实例的统一 ID。接下来可以根据 查询负载均衡实例列表 接口来查询该负载均衡实例是否创建成功。