创建网络型负载均衡实例。
接口说明
- 创建网络型负载均衡实例时会自动为用户创建AliyunServiceRoleForNlb SLR角色。
- CreateLoadBalancer接口属于异步接口，即系统返回一个实例ID，但该网络型负载均衡实例尚未创建成功，系统后台的创建任务仍在进行。您可以调用GetLoadBalancerAttribute查询网络型负载均衡实例的创建状态：
- 当网络型负载均衡实例处于Provisioning状态时，表示网络型负载均衡实例正在创建中。
- 当网络型负载均衡实例处于Active状态时，表示网络型负载均衡实例创建成功。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| nlb:CreateLoadBalancer | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| LoadBalancerType | string | 否 | 负载均衡的类型，仅取值：network，表示网络型负载均衡。 | network |
| LoadBalancerName | string | 否 | 网络型负载均衡实例名称。 长度为2~128个英文或中文字符，必须以大小写英文字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。 | NLB1 |
| AddressType | string | 是 | 网络型负载均衡实例的IPv4地址类型。取值：
说明
网络型负载均衡双栈实例的IPv6公网需通过EnableLoadBalancerIpv6Internet接口开启。
| Internet |
| AddressIpVersion | string | 否 | 协议版本。取值：
| ipv4 |
| VpcId | string | 是 | 网络型负载均衡实例的专有网络ID。 | vpc-bp1b49rqrybk45nio**** |
| ZoneMappings | object [] | 是 | 可用区及交换机映射列表。至少需要添加2个可用区，最多支持添加10个可用区。 | |
| VSwitchId | string | 是 | 可用区对应的交换机，每个可用区只能使用一台交换机和一个子网。至少需要添加2个可用区，最多支持添加10个可用区。 | vsw-sersdf**** |
| ZoneId | string | 是 | 网络型负载均衡实例的可用区ID。至少需要添加2个可用区，最多支持添加10个可用区。 您可以通过调用DescribeZones接口获取可用区ID。 | cn-hangzhou-a |
| PrivateIPv4Address | string | 否 | 私网IP地址。至少需要添加2个可用区，最多支持添加10个可用区。 | 192.168.10.1 |
| AllocationId | string | 否 | 公网实例绑定的EIP实例ID，每个可用区对应1个EIP实例ID。至少需要添加2个可用区，最多支持添加10个可用区。 | eip-bp1aedxso6u80u0qf**** |
| BandwidthPackageId | string | 否 | 公网类型实例关联的共享带宽包ID。 | cbwp-bp1vevu8h3ieh**** |
| LoadBalancerBillingConfig | object | 否 | 网络型负载均衡实例计费配置。 | |
| PayType | string | 否 | 网络型负载均衡实例的计费类型。 仅取值PostPay：表示按量计费。 | PostPay |
| ResourceGroupId | string | 否 | 资源组ID。 | rg-atstuj3rtop**** |
| DryRun | boolean | 否 | 是否只预检此次请求。取值：
| false |
| ClientToken | string | 否 | 客户端Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明
若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
| RegionId | string | 否 | 网络型负载均衡实例所在的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 | cn-hangzhou |
| DeletionProtectionConfig | object | 否 | 删除保护配置。 | |
| Enabled | boolean | 否 | 删除保护状态，取值：
| false |
| Reason | string | 否 | 更改删除保护状态的原因。长度为2~128个英文或中文字符，必须以大小写英文字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。 | 实例运行中 |
| ModificationProtectionConfig | object | 否 | 修改保护配置。 | |
| Status | string | 否 | 网络型负载均衡修改保护状态。取值：
说明
当取值为ConsoleProtection，即开启修改保护后，用户不能通过负载均衡控制台修改实例配置，但可以通过调用API修改实例配置。
| ConsoleProtection |
| Reason | string | 否 | 输入开启修改保护的原因。长度为2~128个英文或中文字符，必须以大小写英文字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。 说明
仅在Status为ConsoleProtection时有效且合法。
| 业务保障期 |
| Tag | object [] | 否 | 标签列表。 | |
| Key | string | 否 | 标签键。最多支持128个字符，不能以 一次调用最多支持添加20个标签。 | env |
| Value | string | 否 | 标签值。最多支持128个字符，不能以 一次调用最多支持添加20个标签。 | product |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
"LoadbalancerId": "nlb-83ckzc8d4xlp8o****",
"OrderId": 20230000
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | OperationDenied.OnlyPayByTrafficSupported | The operation is not allowed because of OnlyPayByTrafficSupported. | 由于仅支持按流量计费，因此不允许进行此操作。 |
| 400 | OperationFailed.%s | The operation failed because of %s. | 因为%操作当前API失败 |
| 400 | Mismatch.ZoneIdAndVswitchId | The ZoneIdAndVswitchId is mismatched for %s and %s. | ZoneId和VswitchId缺失，请检查输入参数。 |
| 400 | QuotaExceeded.%s | The quota of %s is exceeded, usage %s/%s. | %s的配额超过限制，已使用%s/%s |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | dryRun请求验证已通过。 |
| 400 | OperationDenied.OnlyPostPaidSupported | The operation is not allowed because of OnlyPostPaidSupported. | 由于仅支持后付费，因此不允许进行此操作。 |
| 400 | OperationFailed.DuplicateZones. | The operation failed because of Can not Specify duplicate zones. | 由于指定了重复的可用区，操作失败。请修改参数。 |
| 400 | ResourceNotEnough.VSwitchIp | The specified resource of VSwitchIp is not enough. | 所指定的虚拟交换机(VSwitch) IP资源不足。 |
| 400 | DuplicatedParam.AllocationId | The param of AllocationId is duplicated. | AllocationId参数重复，请检查参数。 |
| 400 | ResourceInConfiguring.VswitchId | The specified resource of VswitchId is being configured, please try again later. | 正在配置指定的虚拟交换机资源，请稍后重试。 |
| 400 | IllegalParam | The param of %s is illegal. | 输入的参数有值非法，请检查输入。 |
| 400 | OperationFailed.UnpaidBill | The operation failed because of UnpaidBill. | 您有欠费账单，不符合购买条件。请先充值结清账单后再购买。 |
| 400 | OperationDenied.ServiceLinkedRoleNotExist | The operation is not allowed because of ServiceLinkedRoleNotExist. | 由于服务关联角色不存在（ServiceLinkedRoleNotExist），不允许进行此操作。请检查RAM中是否给NLB进行了授权。 |
| 400 | ResourceAlreadyAssociated.AllocationId | The specified resource of %s is already associated. | 指定的资源AllocationId已经被关联。 |
| 400 | OperationFailed.vSwitchNotSupportIpv6 | The operation failed because of vSwitchNotSupportIpv6. | 所使用的虚拟交换机(vSwicth)不支持ipv6协议，请确认输入参数。 |
| 400 | InvalidZones | The current zone list is illegal. | Zone maping中使用的可用区非法。 |
| 403 | UnauthorizedZone | The specified zone of %s is not authorized. | 指定的可用区%s未被授权使用 |
| 403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因为账号没有权限，所以鉴权失败。 |
| 403 | UnauthorizedRegion | The specified region of %s is not authorized. | 当前region还没有获得授权。 |
| 404 | ResourceNotFound.VSwitch | The specified resource of vSwitch is not found. | 找不到指定的虚拟交换机资源，请检查输入参数。 |
| 404 | ResourceNotFound.Vpc | The specified resource of Vpc is not found. | 找不到指定的VPC资源，请检查输入参数。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-09-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-09-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-09-05 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-08-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-06-30 | API 内部配置变更，不影响调用 | 看变更集 | ||||||||
| ||||||||||
| 2023-06-29 | OpenAPI 入参发生变更 | 看变更集 | ||||||||
|
