CreateLoadBalancer - 创建负载均衡实例 - 负载均衡

创建负载均衡实例。

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

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

请求参数

名称	类型	必填	描述	示例值
AddressIpVersion	string	否	协议版本。取值： Ipv4（默认值）：Ipv4 类型。	Ipv4
LoadBalancerName	string	否	网关型负载均衡实例名称。长度为 2~128 个英文或中文字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。	testGwlbName
VpcId	string	是	专有网络 VPC ID。	vpc-uf6qcgpv22ttrnnjh****
ZoneMappings	array<object>	是	可用区及交换机映射列表。至少需要添加一个可用区，最多支持添加 20 个可用区。若当前地域支持 2 个及以上的可用区，建议添加 2 个及以上可用区。
ZoneEniModel	object	是
VSwitchId	string	是	可用区对应的交换机，每个可用区只能使用一台交换机和一个子网。	vsw-2f0eb020****
ZoneId	string	是	可用区 ID，通过调用网关型负载均衡 DescribeZones 接口获得。	cn-hangzhou-a
Tag	array<object>	否	标签列表。一次调用最多支持 20 个标签。
TagModel	object	否
Key	string	否	标签键。一旦传入该值，则不允许为空字符串。一个标签健最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	testTagKey
Value	string	否	标签值。最多支持 256 个字符，不能包含`http://`或`https://`。	testTagValue
ResourceGroupId	string	否	资源组 ID。	rg-acfmwbufq6q3****
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。	false
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-42665544****

返回参数

名称	类型	描述	示例值
	object
LoadBalancerId	string	网关型负载均衡实例的 ID	gwlb-9njtjmqt7zfcqm****
RequestId	string	请求 ID。	00B19438-66BB-58C3-8C2F-DA5B6F95CBDA

示例

正常返回示例

JSON格式

{
  "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
  "RequestId": "00B19438-66BB-58C3-8C2F-DA5B6F95CBDA"
}

错误码

HTTP status code	错误码	错误信息	描述
400	DuplicatedParam.ZoneId	The param of ZoneId is duplicated.	列表中的ZoneId参数重复
400	OperationDenied.VSwitchNotSupportIpv6	The operation is not allowed because of VSwitchNotSupportIpv6.	交换机Vswitch没有开启IPv6，操作不支持
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.	VSwitch IP资源不足
400	DuplicatedParam.VSwitchId	The param of VSwitchId is duplicated.	列表中的VSwitchId参数重复
400	IllegalParamSize.ZoneMappings	The param size of ZoneMappings is illegal.	ZoneMappings列表数量不合法
400	Mismatch.ZoneIdAndVSwitchId	The ZoneId and VSwitchId are mismatched.	参数ZoneId和VSwitchId的值不匹配
400	QuotaExceeded.LoadBalancersNum	The quota of %s is exceeded for resource %s, usage %s/%s.	配额gwlb_quota_loadbalancers_num已超额度限制。
400	DuplicatedParam.TagKey	The param of %s is duplicated.	标签键参数重复
400	IllegalParam.TagKey	The param of %s is illegal.	标签键参数值不合法

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