CreateLoadBalancer

1. 接口描述

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

准备工作

注意事项

  • 创建预付费负载均衡实例的购买会预先扣除本次实例购买所需金额,如果余额不足,请求将会失败。后付费实例购买时需要确保账户账号状态正常。

  • 调用本接口创建负载均衡实例,支持代金券自动抵扣,详情请参考代金券选用规则。

2. 请求参数

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

参数名称
必选
类型
描述

clientToken

String

用于保证请求的幂等性。

zoneId

String

可用区的节点ID。

loadBalancerName

String

负载均衡名称。

specName

String

规格名称。

chargeType

String

付费类型。

PREPAID:预付费,即包年包月 POSTPAID:后付费。

instanceChargePrepaid

预付费模式。 即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长等属性。若指定实例的付费模式为预付费则该参数必传。

bandwidth

Integer

带宽值。 取值范围:1-1024。 单位:Mbps

ipType

String

指定负载均衡绑定的IP的类型: 可用值:

  • IPv4

  • IPv6

vipCount

Integer

额外购买VIP数量。 负载均衡会默认绑定1个指定类型的IP。

subnetId

String

子网ID。 若是创建VIP4类型时,必须指定子网ID。该实例的主备IP将在该子网中获取。

cidrBlockId

String

CIDR ID。 创建VIP6类型时需要指定CIDR ID。如果该可用区中存在唯一一个CIDR则可以不指定,默认使用该CIDR。

masterIp

String

主IP。

backupIp

String

备IP。

marketingOptions

市场营销活动相关信息。

tags

创建负载均衡时关联的标签。 注意: 关联标签键不能重复。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 requestId。

orderNumber

String

订单号。

loadBalancerId

String

负载均衡ID。

4. 代码示例

  1. 创建负载均衡实例。

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

Request:
{
  "zoneId": "HKG-A",
  "loadBalancerName": "xxxx",
  "specName": "xxxx",
  "clientToken": "xxxx",
  "chargeType": "xxxx",
  "bandwidth": 100,
  "subnetId": "xxxx",
  "ipType": "IPv4"
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "orderNumber": "xxxx",
    "loadBalancerId": "xxxx"
  }
}

5. 开发者工具

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

6. 错误码

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

最后更新于