CreateLoadBalancer_网关型负载均衡_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为100/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
gwlb:CreateLoadBalancer
Create
LoadBalancer
acs:gwlb:{#regionId}:{#accountId}:loadbalancer/*
VSwitch
acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}
VPC
acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

请求参数

字段名称字段详情
AddressIpVersionstring

协议版本。取值:展开详情

示例值:Ipv4枚举值:
LoadBalancerNamestring

网关型负载均衡实例名称。展开详情

示例值:testGwlbName参考取值来源:
    ListLoadBalancers
    GetLoadBalancerAttribute
VpcIdstring

专有网络 VPC ID。

示例值:vpc-uf6qcgpv22ttrnnjh****
ZoneMappingsarray<object>

可用区及交换机映射列表。至少需要添加一个可用区,最多支持添加 20 个可用区。若当前地域支持 2 个及以上的可用区,建议添加 2 个及以上可用区。

子级条数 <= 20
Tagarray<object>

标签列表。一次调用最多支持 20 个标签。

子级条数 <= 20
ResourceGroupIdstring

资源组 ID。

示例值:rg-acfmwbufq6q3****参考取值来源:
    ListServerGroups
DryRunboolean

是否只预检此次请求。取值:展开详情

示例值:false
ClientTokenstring

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

示例值:123e4567-e89b-12d3-a456-42665544****

返回参数

字段名称字段详情
LoadBalancerIdstring

网关型负载均衡实例的 ID

示例值:gwlb-9njtjmqt7zfcqm****
RequestIdstring

请求 ID。

示例值:00B19438-66BB-58C3-8C2F-DA5B6F95CBDA

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
DuplicatedParam.ZoneId
The param of ZoneId is duplicated.诊断
400
OperationDenied.VSwitchNotSupportIpv6
The operation is not allowed because of VSwitchNotSupportIpv6.诊断
400
ResourceNotEnough.VSwitchIp
The specified resource of VSwitchIp is not enough.诊断
400
DuplicatedParam.VSwitchId
The param of VSwitchId is duplicated.诊断
400
IllegalParamSize.ZoneMappings
The param size of ZoneMappings is illegal.诊断
400
Mismatch.ZoneIdAndVSwitchId
The ZoneId and VSwitchId are mismatched.诊断
400
QuotaExceeded.LoadBalancersNum
The quota of %s is exceeded for resource %s, usage %s/%s.诊断
400
DuplicatedParam.TagKey
The param of %s is duplicated.诊断
400
IllegalParam.TagKey
The param of %s is illegal.诊断

变更历史

暂无变更历史

相关示例