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

使用说明

CreateLoadBalancer接口属于异步接口,即系统返回一个实例ID,但该应用型负载均衡实例尚未创建成功,系统后台的创建任务仍在进行。您可以调用GetLoadBalancerAttribute查询应用型负载均衡实例的创建状态:

  • 当应用型负载均衡实例处于Provisioning状态时,表示应用型负载均衡实例正在创建中。
  • 当应用型负载均衡实例处于Active状态时,表示应用型负载均衡实例创建成功。

调试

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

请求参数

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

要执行的操作。

取值:CreateLoadBalancer

ClientToken String 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
DryRun Boolean false

是否只预检此次请求,取值:

  • true:发送检查请求,不会创建应用型负载均衡实例。检查项包括是否填写了必需参数、请求格式和业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回HTTP_2xx状态码并直接进行操作。
VpcId String vpc-bp1b49rqrybk45nio****

应用型负载均衡实例的专有网络ID。

AddressType String Internet

应用型负载均衡的地址类型。取值:

  • Internet:负载均衡具有公网IP地址,DNS域名被解析到公网IP,因此可以在公网环境访问。
  • Intranet:负载均衡只有私网IP地址,DNS域名被解析到私网IP,因此只能被负载均衡所在VPC的内网环境访问。
LoadBalancerName String alb1

应用型负载均衡实例名称。

长度为2~128个英文或中文字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

DeletionProtectionEnabled Boolean false

是否开启删除保护。取值:

  • true:开启。
  • false(默认值):关闭。
ModificationProtectionConfig Object

修改保护配置。

Reason String 托管实例

输入开启删除保护的原因。长度为2~128个英文或中文字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

说明 仅在StatusConsoleProtection时该参数有效且合法。
Status String ConsoleProtection

修改负载均衡实例的删除保护状态。取值:

  • NonProtection:不保护,表示不允许传入ModificationProtectionReason。如果配置了ModificationProtectionReason,则清空其配置信息。
  • ConsoleProtection:控制台修改保护,此时允许传入ModificationProtectionReason。
ZoneMappings.N.VSwitchId String vsw-sersdf****

可用区对应的交换机,每个可用区只能使用一台交换机和一个子网。最多支持添加10个可用区。

ZoneMappings.N.ZoneId String cn-hangzhou-a

应用型负载均衡实例的可用区ID。最多支持添加10个可用区。

您可以通过调用DescribeZones接口获取可用区ID对应的可用区的信息。

AddressAllocatedMode String Dynamic

地址模式。取值 :

  • Fixed:固定IP模式,表示使用固定的IP地址。
  • Dynamic(默认):动态IP模式,表示每个可用区动态分配IP地址。
ResourceGroupId String rg-atstuj3rtop****

企业资源组ID。

LoadBalancerEdition String Standard

应用型负载均衡的版本,不同版本有不同功能限制和计费策略。取值:

  • Basic:基础版。
  • Standard:标准版。
  • StandardWithWaf:WAF增强版。
LoadBalancerBillingConfig Object

负载均衡实例计费配置。

PayType String PostPay

实例的计费类型。

仅取值PostPay:表示按量计费。

BandwidthPackageId String cbwp-bp1vevu8h3ieh****

公网类型实例关联的共享带宽包ID。

AddressIpVersion String IPv4

协议版本。取值:

  • IPv4:IPv4类型。
  • DualStack:双栈类型。

返回数据

名称 类型 示例值 描述
LoadBalancerId String lb-bp1o94dp5i6ea****

负载均衡实例ID。

RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateLoadBalancer
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&DryRun=false
&VpcId=vpc-bp1b49rqrybk45nio****
&AddressType=Internet
&LoadBalancerName=alb1
&DeletionProtectionEnabled=false
&ModificationProtectionConfig={"Reason":"托管实例","Status":"ConsoleProtection"}
&ZoneMappings=[{"VSwitchId":"vsw-sersdf****","ZoneId":"cn-hangzhou-a"}]
&AddressAllocatedMode=Dynamic
&ResourceGroupId=rg-atstuj3rtop****
&LoadBalancerEdition=Standard
&LoadBalancerBillingConfig={"PayType":"PostPay"}
&AddressIpVersion=IPv4
&公共请求参数

正常返回示例

XML格式

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

<CreateLoadBalancerResponse>
    <LoadBalancerId>lb-bp1o94dp5i6ea****</LoadBalancerId>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
</CreateLoadBalancerResponse>

JSON格式

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

{
  "LoadBalancerId" : "lb-bp1o94dp5i6ea****",
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

错误码

HttpCode 错误码 错误信息 描述
400 ResourceNotEnough.VSwitchIp The specified resource %s is not enough. 资源%s不足。
400 QuotaExceeded.LoadBalancersNum The quota of %s is exceeded, usage %s/%s. 配额%s已超额度限制,目前已使用%s,配额为%s。
400 Mismatch.ZoneIdAndVSwitchId The %s and %s are mismatched. %s和%s不匹配。
400 DuplicatedParam.ZoneId The param of ZoneId is duplicated. 参数ZoneId重复
404 ResourceNotFound.VSwitch The specified resource %s is not found. 资源%s不存在。

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