在指定地域创建应用型负载均衡实例。
接口说明
CreateLoadBalancer接口属于异步接口,即系统返回一个实例ID,但该应用型负载均衡实例尚未创建成功,系统后台的创建任务仍在进行。您可以调用GetLoadBalancerAttribute查询应用型负载均衡实例的创建状态:
- 当应用型负载均衡实例处于Provisioning状态时,表示应用型负载均衡实例正在创建中。
- 当应用型负载均衡实例处于Active状态时,表示应用型负载均衡实例创建成功。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alb:CreateLoadBalancer | Write |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 |
客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明 | 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
DryRun | boolean | 否 | 是否只预检此次请求,取值:
|
false |
VpcId | string | 是 |
应用型负载均衡实例的专有网络ID。 |
vpc-bp1b49rqrybk45nio**** |
AddressType | string | 是 |
应用型负载均衡的地址类型。取值:
|
Internet |
LoadBalancerName | string | 否 |
应用型负载均衡实例名称。 长度为2~128个英文或中文字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。 |
alb1 |
DeletionProtectionEnabled | boolean | 否 |
是否开启删除保护。取值:
|
false |
ModificationProtectionConfig | object | 否 |
修改保护配置。 |
|
Reason | string | 否 |
输入开启修改保护的原因。长度为2~128个英文或中文字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。 说明 | 托管实例 |
Status | string | 否 | 修改应用型负载均衡实例的修改保护状态。取值:
说明 | ConsoleProtection |
ZoneMappings | object [] | 是 | 可用区及交换机映射列表,至少指定两个可用区。 |
|
VSwitchId | string | 是 |
可用区对应的交换机,每个可用区只能使用一台交换机和一个子网。最多支持添加10个可用区。 |
vsw-sersdf**** |
ZoneId | string | 是 |
应用型负载均衡实例的可用区ID。最多支持添加10个可用区。 您可以通过调用DescribeZones接口获取可用区ID对应的可用区的信息。 |
cn-hangzhou-a |
AllocationId | string | 否 |
公网实例绑定的EIP实例ID。至少需要添加2个可用区,最多支持添加10个可用区。 |
eip-bp1aedxso6u80u0qf**** |
IntranetAddress | string | 否 |
IPv4私网地址。至少需要添加2个可用区,最多支持添加10个可用区。 |
192.168.10.1 |
AddressAllocatedMode | string | 否 |
地址模式。取值 :
|
Dynamic |
ResourceGroupId | string | 否 |
企业资源组ID。 |
rg-atstuj3rtop**** |
LoadBalancerEdition | string | 是 |
应用型负载均衡的版本,不同版本有不同功能限制和计费策略。取值:
|
Standard |
LoadBalancerBillingConfig | object | 是 |
应用型负载均衡实例计费配置。 |
|
PayType | string | 是 |
实例的计费类型。 仅取值PostPay:表示按量计费。 |
PostPay |
BandwidthPackageId | string | 否 |
公网类型实例关联的共享带宽包ID。 |
cbwp-bp1vevu8h3ieh**** |
AddressIpVersion | string | 否 |
协议版本。取值:
|
IPv4 |
Tag | object [] | 否 |
标签。 |
|
Key | string | 否 |
最多支持128个字符,不能以aliyun或acs:开头,不能包含http://或https://。 |
env |
Value | string | 否 |
最多支持128个字符,不能以aliyun或acs:开头,不能包含http://或https://。 |
product |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
创建负载均衡实例。 |
||
LoadBalancerId | string |
应用型负载均衡实例ID。 |
alb-o9ulmq5hgn68jk**** |
RequestId | string |
请求ID。 |
CEF72CEB-54B6-4AE8-B225-F876FF7BA984 |
示例
正常返回示例
JSON
格式
{
"LoadBalancerId": "alb-o9ulmq5hgn68jk****",
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2023-11-03 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
|
||||||||
2023-10-30 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/168361.html