API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心

创建黑石负载均衡实例

最近更新时间：2024-03-12 01:11:06

我的收藏

本页目录：

1. 接口描述

接口请求域名： bmlb.tencentcloudapi.com 。

用来创建黑石负载均衡。为了使用黑石负载均衡服务，您必须要创建一个或者多个负载均衡实例。通过成功调用该接口，会返回负载均衡实例的唯一ID。用户可以购买的黑石负载均衡实例类型分为：公网类型、内网类型。公网类型负载均衡对应一个BGP VIP，可用于快速访问公网负载均衡绑定的物理服务器；内网类型负载均衡对应一个腾讯云内部的VIP，不能通过Internet访问，可快速访问内网负载均衡绑定的物理服务器。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateLoadBalancers。
Version 是 String 公共参数，本接口取值：2018-06-25。
Region 是 String 公共参数，详见产品支持的 地域列表。
VpcId 是 String 黑石负载均衡实例所属的私有网络ID。
LoadBalancerType 是 String 负载均衡的类型，取值为open或internal。open表示公网(有日租)，internal表示内网。
SubnetId 否 String 在私有网络内购买内网负载均衡实例的时候需要指定子网ID，内网负载均衡实例的VIP将从这个子网中产生。其他情况不用填写该字段。
ProjectId 否 Integer 负载均衡所属项目ID。不填则属于默认项目。
GoodsNum 否 Integer 购买黑石负载均衡实例的数量。默认值为1, 最大值为20。
PayMode 否 String 黑石负载均衡的计费模式，取值为flow和bandwidth，其中flow模式表示流量模式，bandwidth表示带宽模式。默认值为flow。
TgwSetType 否 String 负载均衡对应的TGW集群类别，取值为tunnel、fullnat或dnat。tunnel表示隧道集群，fullnat表示FULLNAT集群（普通外网负载均衡），dnat表示DNAT集群（增强型外网负载均衡）。默认值为fullnat。如需获取client IP，可以选择 tunnel 模式，fullnat 模式（tcp 通过toa 获取），dnat 模式。
Exclusive 否 Integer 负载均衡的独占类别，取值为0表示非独占，1表示四层独占，2表示七层独占，3表示四层和七层独占，4表示共享容灾。
SpecifiedVips.N 否 Array of String 指定的VIP，如果指定，则数量必须与goodsNum一致。如果不指定，则由后台分配随机VIP。
BzConf 否 CreateLoadBalancerBzConf （未全地域开放）保障型负载均衡设定参数，如果类别选择保障型则需传入此参数。
IpProtocolType 否 String IP协议类型。可取的值为“ipv4”或“ipv6”。

3. 输出参数

参数名称 类型 描述
LoadBalancerIds Array of String 创建的黑石负载均衡实例ID。
TaskId String 创建负载均衡的异步任务ID。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建一个外网负载均衡实例

输入示例

https://bmlb.tencentcloudapi.com/?Action=CreateLoadBalancers
&GoodsNum=1
&LoadBalancerType=open
&VpcId=vpc-34cxlz7z
&IpProtocolType=ipv4
&<公共请求参数>

输出示例

{
    "Response": {
        "LoadBalancerIds": [
            "lb-m1i50ynj"
        ],
        "TaskId": "2385670",
        "RequestId": "99e29d13-71a3-4d75-b938-e4241a4f7aa6"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
中国站