首页 负载均衡 应用型负载均衡ALB 开发参考 API参考 API目录 实例 CreateLoadBalancer - 创建应用型负载均衡实例

CreateLoadBalancer - 创建应用型负载均衡实例

更新时间: 2023-11-03 09:55:00

在指定地域创建应用型负载均衡实例。

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alb:CreateLoadBalancerWrite
  • LoadBalancer
    acs:alb:{#regionId}:{#accountId}:loadbalancer/*
  • alb:AddressType

请求参数

名称类型必填描述示例值
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRunboolean

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

  • true:发送检查请求,不会创建应用型负载均衡实例。检查项包括是否填写了必需参数、请求格式和业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。

false
VpcIdstring

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

vpc-bp1b49rqrybk45nio****
AddressTypestring

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

  • Internet:负载均衡具有公网IP地址,DNS域名被解析到公网IP,因此可以在公网环境访问。

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

Internet
LoadBalancerNamestring

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

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

alb1
DeletionProtectionEnabledboolean

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

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

修改保护配置。

Reasonstring

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

说明 仅在StatusConsoleProtection时该参数有效且合法。
托管实例
Statusstring

修改应用型负载均衡实例的修改保护状态。取值:

  • NonProtection:不保护,表示不允许传入ModificationProtectionReason。如果配置了ModificationProtectionReason,则清空其配置信息。

  • ConsoleProtection:控制台修改保护,此时允许传入ModificationProtectionReason。

说明 当取值为ConsoleProtection,即开启修改保护后,用户不能通过负载均衡控制台修改实例配置,但可以通过调用API修改实例配置。
ConsoleProtection
ZoneMappingsobject []

可用区及交换机映射列表,至少指定两个可用区。

VSwitchIdstring

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

vsw-sersdf****
ZoneIdstring

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

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

cn-hangzhou-a
AllocationIdstring

公网实例绑定的EIP实例ID。至少需要添加2个可用区,最多支持添加10个可用区。

eip-bp1aedxso6u80u0qf****
IntranetAddressstring

IPv4私网地址。至少需要添加2个可用区,最多支持添加10个可用区。

192.168.10.1
AddressAllocatedModestring

地址模式。取值 :

  • Fixed:固定IP模式,表示使用固定的IP地址。

  • Dynamic(默认):动态IP模式,表示每个可用区动态分配IP地址。

Dynamic
ResourceGroupIdstring

企业资源组ID。

rg-atstuj3rtop****
LoadBalancerEditionstring

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

  • Basic:基础版。

  • Standard:标准版。

  • StandardWithWaf:WAF增强版。

Standard
LoadBalancerBillingConfigobject

应用型负载均衡实例计费配置。

PayTypestring

实例的计费类型。

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

PostPay
BandwidthPackageIdstring

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

cbwp-bp1vevu8h3ieh****
AddressIpVersionstring

协议版本。取值:

  • IPv4:IPv4类型。
  • DualStack:双栈类型。
IPv4
Tagobject []

标签。

Keystring

最多支持128个字符,不能以aliyun或acs:开头,不能包含http://或https://。

env
Valuestring

最多支持128个字符,不能以aliyun或acs:开头,不能包含http://或https://。

product

返回参数

名称类型描述示例值
object

创建负载均衡实例。

LoadBalancerIdstring

应用型负载均衡实例ID。

alb-o9ulmq5hgn68jk****
RequestIdstring

请求ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-11-03OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
2023-10-30OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
阿里云首页 负载均衡 相关技术圈