调用CreateLoadBalancer接口创建网络型负载均衡实例。

使用说明

  • 创建网络型负载均衡实例时会自动为用户创建AliyunServiceRoleForNlb SLR角色。
  • CreateLoadBalancer接口属于异步接口，即系统返回一个实例ID，但该网络型负载均衡实例尚未创建成功，系统后台的创建任务仍在进行。您可以调用GetLoadBalancerAttribute查询网络型负载均衡实例的创建状态：
    • 当网络型负载均衡实例处于Provisioning状态时，表示网络型负载均衡实例正在创建中。
    • 当网络型负载均衡实例处于Active状态时，表示网络型负载均衡实例创建成功。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateLoadBalancer

系统规定参数。取值：CreateLoadBalancer。
LoadBalancerType String 否 network

负载均衡的类型，仅取值：network，表示网络型负载均衡。
LoadBalancerName String 否 NLB1

网络型负载均衡实例名称。

长度为2~128个英文或中文字符，必须以大小写英文字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。
AddressType String 是 Internet

网络型负载均衡实例的IPv4地址类型。取值：

  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
说明 网络型负载均衡双栈实例的IPv6公网需通过EnableLoadBalancerIpv6Internet接口开启。
AddressIpVersion String 否 ipv4

协议版本。取值：

  • ipv4（默认值）：IPv4类型。
  • DualStack：双栈类型。
VpcId String 是 vpc-bp1b49rqrybk45nio****

网络型负载均衡实例的专有网络ID。
ZoneMappings.N.VSwitchId String 是 vsw-sersdf****

可用区对应的交换机，每个可用区只能使用一台交换机和一个子网。至少需要添加2个可用区，最多支持添加10个可用区。
ZoneMappings.N.ZoneId String 是 cn-hangzhou-a

网络型负载均衡实例的可用区ID。至少需要添加2个可用区，最多支持添加10个可用区。

您可以通过调用DescribeZones接口获取可用区ID。
ZoneMappings.N.PrivateIPv4Address String 否 192.168.10.1

私网IP地址。至少需要添加2个可用区，最多支持添加10个可用区。
ZoneMappings.N.AllocationId String 否 eip-bp1aedxso6u80u0qf****

公网实例绑定的EIP实例ID，每个可用区对应1个EIP实例ID。至少需要添加2个可用区，最多支持添加10个可用区。
BandwidthPackageId String 否 cbwp-bp1vevu8h3ieh****

公网类型实例关联的共享带宽包ID。
LoadBalancerBillingConfig.PayType String 否 PostPay

网络型负载均衡实例的计费类型。

仅取值PostPay：表示按量计费。
ResourceGroupId String 否 rg-atstuj3rtop****

资源组ID。
DryRun Boolean 否 false

是否只预检此次请求。取值：

  • true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。
ClientToken String 否 123e4567-e89b-12d3-a456-426655440000

客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
RegionId String 否 cn-hangzhou

网络型负载均衡实例所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。
DeletionProtectionConfig.Enabled Boolean 否 false

删除保护状态，取值：

  • true：开启状态。
  • false（默认值）：关闭状态。
DeletionProtectionConfig.Reason String 否 实例运行中

更改删除保护状态的原因。长度为2~128个英文或中文字符，必须以大小写英文字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。
ModificationProtectionConfig.Status String 否 ConsoleProtection

网络型负载均衡修改保护状态。取值：

  • NonProtection：不保护，表示不允许传入保护配置的Reason。如果配置了保护配置的Reason，则清空其配置信息。
  • ConsoleProtection：控制台修改保护，此时允许传入保护配置的Reason。
说明 当取值为ConsoleProtection，即开启修改保护后，用户不能通过负载均衡控制台修改实例配置，但可以通过调用API修改实例配置。
ModificationProtectionConfig.Reason String 否 业务保障期

输入开启修改保护的原因。长度为2~128个英文或中文字符，必须以大小写英文字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。

说明 仅在Status为ConsoleProtection时有效且合法。

返回数据

名称 类型 示例值 描述
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

请求ID。
LoadbalancerId String nlb-83ckzc8d4xlp8o****

实例ID。
OrderId Long 20230000

网络型负载均衡实例的订单ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateLoadBalancer
&LoadBalancerType=network
&LoadBalancerName=NLB1
&AddressType=Internet
&AddressIpVersion=ipv4
&VpcId=vpc-bp1b49rqrybk45nio****
&ZoneMappings=[{"VSwitchId":"vsw-sersdf****","ZoneId":"cn-hangzhou-a","PrivateIPv4Address":"192.168.10.1","AllocationId":"eip-bp1aedxso6u80u0qf****"}]
&BandwidthPackageId=cbwp-bp1vevu8h3ieh****
&LoadBalancerBillingConfig={"PayType":"PostPay"}
&ResourceGroupId=rg-atstuj3rtop****
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&DeletionProtectionConfig={"Enabled":false,"Reason":"实例运行中"}
&ModificationProtectionConfig={"Status":"ConsoleProtection","Reason":"业务保障期"}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateLoadBalancerResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <LoadbalancerId>nlb-83ckzc8d4xlp8o****</LoadbalancerId>
    <OrderId>20230000</OrderId>
</CreateLoadBalancerResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "LoadbalancerId" : "nlb-83ckzc8d4xlp8o****",
  "OrderId" : 20230000
}

错误码

访问错误中心查看更多错误码。