CreateLoadBalancer

1. 接口描述

本接口用于创建负载均衡器实例。

注意事项

  • 你可以通过 DescribeLoadBalancerRegions 接口来查看支持购买负载均衡的地域。

  • 本接口为异步接口,接口成功返回后,可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态。其中状态为RUNNING则代表创建成功。

  • 当前只支持为ZEC服务器创建负载均衡实例。

  • 只支持后付费负载均衡实例创建。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

regionId

String

区域节点ID。

vpcId

String

负载均衡后端服务器所属的VPC网络 ID。

loadBalancerName

String

负载均衡实例名称。

长度为1~64个字符。

可选值范围:[1.0, +)。

internetChargeType

IP网络计费模式。

ipNetworkType

IP 的网络类型。

bandwidthMbps

Integer

EIP的最大出带宽。

单位为Mbps。

最大限制通常为10000,如果有额外要求, 请联系Support。

可选值范围:[1, +)。

trafficPackageSize

Float

流量包大小。

指定此参数时,IP网络计费模式(internetChargeType) 需为ByTrafficPackage, 否则该参数不生效。

可选值范围:[0.0, 999999.0]。

bandwidthClusterId

String

共享带宽包ID。

指定此参数时,IP网络计费模式(internetChargeType) 需为BandwidthCluster, 否则该参数不生效。

resourceGroupId

String

资源组ID。

如果不指定,则会创建在默认资源组。

number

Integer

创建负载均衡的个数。

默认值:1。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

orderNumber

String

下单编号。

loadBalancerIds

Array of String

由负载均衡实例唯一 ID 组成的集合。

4. 代码示例

1. 创建一个公网负载均衡实例。 IP计费方式为固定带宽。

POST /api/v2/zlb HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateLoadBalancer
<Common Request Params>

Request:
{
  "regionId" : "asia-east-1",
  "vpcId" : "<vpcId>",
  "loadBalancerName" : "sample",
  "internetChargeType" : "ByBandwidth",
  "ipNetworkType" : "BGPLine",
  "bandwidthMbps" : 2,
  "trafficPackageSize" : null,
  "bandwidthClusterId" : "",
  "number" : 1
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "orderNumber": "<orderNumber>",
    "loadBalancerIds": ["<loadBalancerId>"]
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码
错误码
说明

404

INVALID_VPC_NOT_FOUND

VPC 不存在。

最后更新于