文档

CreateLoadBalancer - 创建传统型负载均衡实例

更新时间:

创建负载均衡实例。

接口说明

注意事项

  • 实例创建前,请调用 DescribeAvailableResource 查询可用区支持的资源售卖情况。
  • 实例创建后,会产生费用。
  • 按量付费模式支持创建按规格计费实例和按使用量计费实例。

调试

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

授权信息

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

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

请求参数

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

传统型负载均衡实例的地域 ID。

您可以通过调用 DescribeRegions 接口查询地域 ID。

cn-hangzhou
AddressTypestring

传统型负载均衡实例的网络类型。取值:

  • internet:创建公网负载均衡实例后,系统会分配一个公网 IP 地址,可以转发公网请求。
  • intranet:创建专有网络类型的负载均衡实例后,系统会分配一个内网 IP 地址,仅可转发内网请求。
internet
InternetChargeTypestring

公网类型实例的付费方式。取值:

  • paybytraffic(默认值):按使用流量计费。

    说明 如果选择了 paybytraffic,无需设置 Bandwidth 的值;如您设置了 Bandwidth 值,该值也不会生效。
  • paybybandwidth:按固定带宽计费。

说明 PayType 取值 PayOnDemandInstanceChargeType 取值 PayByCLCU 时,该参数仅支持取值 paybytraffic
paybytraffic
Bandwidthinteger

监听的带宽峰值,单位:Mbps。

取值范围:15120。对于按带宽计费的公网负载均衡实例,可以设置每个监听的带宽峰值,但所有监听的带宽峰值之和不能超过实例的带宽峰值。

10
ClientTokenstring

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

由客户端生成该参数值,要保证在不同请求间唯一。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3
LoadBalancerNamestring

传统型负载均衡实例的名称。

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

不指定该参数时,默认由系统分配一个实例名称。

lb-bp1o94dp5i6ea****
VpcIdstring

传统型负载均衡实例的所属的 VPC ID。

vpc-bp1aevy8sofi8mh1****
VSwitchIdstring

专有网络实例的所属的交换机 ID。

创建专有网络类型的负载均衡实例,必须指定该参数。如果指定了该参数,AddessType 参数的值会默认被设置为 intranet

vsw-bp12mw1f8k3jgy****
MasterZoneIdstring

传统型负载均衡实例的主可用区 ID。

您可以通过调用 DescribeZone 接口可查到相应地域下的主备可用区信息。

cn-hangzhou-b
SlaveZoneIdstring

传统型负载均衡实例的备可用区 ID。

您可以通过调用 DescribeZone 接口查询相应地域下的主备可用区信息。

cn-hangzhou-d
LoadBalancerSpecstring

传统型负载均衡实例的规格。取值:

  • slb.s1.small
  • slb.s2.small
  • slb.s2.medium
  • slb.s3.small
  • slb.s3.medium
  • slb.s3.large
说明 若不指定规格,则创建性能共享型实例。目前,共享型实例已停止售卖,请指定实例规格。

InstanceChargeType 取值为 PayByCLCU,该参数不生效,您无需配置该参数。

slb.s1.small
ResourceGroupIdstring

企业资源组 ID。

rg-atstuj3rtopt****
PayTypestring

实例的计费类型,取值:

  • PayOnDemand:按量付费。
  • PrePay:包年包月。
说明 如果该参数设置为 PrePay,即表示创建包年包月实例,则 Duration 参数必选。
PayOnDemand
PricingCyclestring

预付费公网实例的计费周期,取值:

  • month:月。
  • year:年。
说明 该参数仅适用于中国站且仅对包年包月实例有效。
month
Durationinteger

预付费公网实例的购买时长,取值:

  • 如果 PricingCyclemonth,取值为1~9
  • 如果 PricingCycleyear,取值为1~5
说明 该参数仅适用于中国站且仅对包年包月实例有效。
1
AutoPayboolean

是否是自动支付预付费公网实例的账单。取值:

  • true:自动支付。调用 API 后,立即生成 SLB 实例。
  • false(默认值):调用 API 后 SLB 的订单创建成功,但是未支付。您可以在控制台看到未支付订单。由于订单未支付,SLB 实例不会被创建出来。
说明 该参数仅适用于中国站且仅对包年包月实例有效。
true
AddressIPVersionstring

传统型负载均衡实例的 IP 版本,取值:ipv4ipv6

ipv4
Addressstring

指定实例的私网 IP 地址,该地址必须包含在交换机的目标网段下。

192.168.XX.XX
Tagobject []

标签列表。

Keystring

实例的标签键。N 的取值范围:1~20。一旦输入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

test
Valuestring

实例的标签值。N 的取值范围:1~20。一旦输入该值,可以为空字符串。 最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

value
DeleteProtectionstring

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

  • on:是。
  • off:否。
on
ModificationProtectionStatusstring

传统型负载均衡修改保护状态:

  • NonProtection:不限制修改保护,设置后会清空之前设置的 ModificationProtectionReason
  • ConsoleProtection:实例控制台修改保护状态。
说明 当取值为 ConsoleProtection,即开启修改保护后,用户不能通过负载均衡控制台修改实例配置,但可以通过调用 API 修改实例配置。
ConsoleProtection
ModificationProtectionReasonstring

设置修改保护状态的原因,长度为 1~80 个字符,必须以字母或中文开头,支持数字、半角句号(.)、下划线(_)和短划线(-)。

说明 仅在 ModificationProtectionStatusConsoleProtection 时有效。
Managed instance
InstanceChargeTypestring

实例计费方式。取值:

  • PayBySpec(默认值):按规格计费。
  • PayByCLCU:按使用量计费。
说明 该参数仅适用于中国站且仅当 PayType(实例付费模式)取值为 PayOnDemand(按量付费)时,该参数生效。
PayBySpec

返回参数

名称类型描述示例值
object
VpcIdstring

传统型负载均衡实例的所属专有网络的 ID。

vpc-25dvzy9****
AddressIPVersionstring

传统型负载均衡实例的 IP 地址类型。

ipv4
VSwitchIdstring

传统型负载均衡实例的所属交换机的 ID。

vsw-255ecr****
RequestIdstring

请求 ID。

365F4154-92F6-4AE4-92F8-7FF34B540710
LoadBalancerNamestring

传统型负载均衡实例的名称。

lb-bp1o94dp5i6ea****
LoadBalancerIdstring

传统型负载均衡实例的 ID。

lb-hddhfjg****
ResourceGroupIdstring

资源组 ID。

rg-atstuj3rto****
Addressstring

分配的负载均衡实例的 IP 地址。

42.XX.XX.6
NetworkTypestring

传统型负载均衡实例的网络类型,取值:

  • vpc:专有网络实例。
  • classic:经典网络实例。
classic
OrderIdlong

预付费实例的订单 ID。

20212961978****

示例

正常返回示例

JSON格式

{
  "VpcId": "vpc-25dvzy9****",
  "AddressIPVersion": "ipv4",
  "VSwitchId": "vsw-255ecr****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "LoadBalancerName": "lb-bp1o94dp5i6ea****",
  "LoadBalancerId": "lb-hddhfjg****",
  "ResourceGroupId": "rg-atstuj3rto****",
  "Address": "42.XX.XX.6",
  "NetworkType": "classic",
  "OrderId": 0
}

错误码

HTTP status code错误码错误信息描述
400OperationFailed.ZoneResourceLimitThe operation failed because of resource limit of the specified zone.操作失败,原因是当前可用区资源不足。
400CloudBoxNotSupportIpv6The cloudBox instance does not support ipv6.云盒实例不支持ipv6
400CloudBoxNotSupportInternetThe cloudBox instance does not support internet.云盒实例不支持internet
400OperationFailed.RegionResourceLimitThe operation failed because of resource limit of the specified region.操作失败,原因是指定地域资源不足。
400Operation.NotAllowedOperation Denied. The charge type of internet prepay instance can only be paybybandwidth.操作被拒绝,原因是公网预付费实例只支持按带宽计费。
400Operation.NotAllowedOperation Denied. The charge type of intranet prepay instance can only be paybytraffic.操作被拒绝,原因是私网预付费实例只支持按流量计费。
400OperationFailed.UnpaidBillsExistThe account has unpaid bills. Please pay your overdue bill first.操作失败,原因是当前账户下存在未支付账单。请先支付您的逾期账单。
400RegionOrZonesNotSupportIpv6The specified region or master/slave zones does not support ipv6.指定地域或主备可用区不支持Ipv6。
400InvalidParameter.MismatchAddressType and IpVersion is conflict, IPv6 does not support intranet instance.网络类型和IP版本冲突,私网实例不支持IPv6。
400PAYFOR.CREDIT_PAY_INSUFFICIENT_BALANCEYour account does not have enough balance.-
400HighRiskOperationDeniedThe operation is denied because of high risk.操作被拒绝,原因是当前操作为高危操作。
400VSwitchAvailableIpNotExistThe specified VSwitch has no availabe ip.指定的交换机没有可用的Ip。
400VSwitchNotExistThe specified VSwitch does not exist.指定的交换机不存在。
400InvalidParameterIllegal parameter. The IP address is not in subnet.参数非法,IP地址不在子网中。
400Instance.ShareSlbNotSupportPay95Illegal parameter. The share instance not support PayBy95 or PayByOld95.共享型实例不支持PayBy95或PayByOld95。
400Instance.Pay95RateInvalidIllegal parameter. The rate is illegal.指定的Rate无效。请检查参数约束,并在修改后重试。
400Instance.Pay95BandwidthIllegalIllegal parameter. The bandwidth is illegal.指定的Bandwidth无效。请检查参数约束,并在修改后重试。
400Instance.InternetChargeTypeNotAllowedIllegal parameter. The specified InternetChargeType not allowed.参数非法,指定的InternetChargeType不支持。
400OperationFailed.TokenIsProcessingThe operation is failed, because the Client Token is processing.操作失败,原因是当前请求正在处理中。
400InsufficientBalanceYour account does not have enough balance.账户余额不足,请先充值再操作。
400MissingParam.VSwitchIdThe parameter VSwitchId is required.参数VSwitchId缺失。
400InvalidVpcId.NotExistThe specified VPC not exist.指定的VPC不存在。
400PAY.MAYI_WITHHOLDING_AGREEMENT_ILLEGALYour account did not sign a withholding agreement or no coupons in Alipay.-
400InvalidParameter.CloudTypeThe specified CloudType is invalid.指定的CloudType无效。请检查参数约束,并在修改后重试。
400OperationFailed.InvalidAccountThe account information is incomplete.操作失败,原因是账户信息不完整。
400RegionOrZonesNotSupportCENThe specified region or master/slave zones does not support cloudType of hybrid_cen.指定的地域或主备可用区不支持CEN。
400MissingParam.LoadBalancerSpecThe param LoadBalancerSpec is required.参数LoadBalancerSpec缺失。
400InvalidParameter.BandwidthThe param Bandwidth is invalid.指定的Bandwidth无效。请检查参数约束,并在修改后重试。
400OperationForbidden.AccountRiskRejectThe operation failed because of account risk reject.操作失败,原因是当前账户已被风控。
400OperationForbidden.QuotaLimitThe operation failed because of quota limit of shared loadbalancers.操作失败,原因是共享性实例数量已达配额上限。
400InvalidParam.ModificationProtectionStatusThe param ModificationProtectionStatus is invalid.指定的ModificationProtectionStatus无效。请检查参数约束,并在修改后重试。
400InvalidParam.ModificationProtectionReasonThe param ModificationProtectionReason is invalid.指定的ModificationProtectionReason无效。请检查参数约束,并在修改后重试。
400InvalidParam.ModificationProtectionReason%s.指定的ModificationProtectionReason无效。请检查参数约束,并在修改后重试。
400ShareSlbHaltSalesThe share instance has been discontinued.共享型负载均衡实例已售罄。
400OperationFailed.CashBookInsufficientNo payment method is specified for your account, We recommend that you add a payment method or maintain a prepayment balance.操作失败,原因是您的账户未指定付款方式,我们建议您添加付款方式或保持预付款余额。
400OperationFailed.OnlyInnerCommoditySupportToPurchaseAliCroup2Cloud user only can buy inner commodity.操作失败,原因是集团上云用户只能购买内部商品。
400OperationFailed.InvokeLingXiaoFailedFailed to invoke lingxiao service.操作失败,原因是调用凌霄服务失败。
400AllocateVpcInstanceFailedFailed to allocate vpc instance.分配VPC实例失败。
400QueryCreditCtrlInfoFailedFailed to query credit ctrl info.查询用户信息失败。
400QueryCommodityCenterFailedFailed to query commodity center.商品中心查询失败。
400RegionNotSupportParameterCurrent region does not support the param of %s.当前地域不支持指定参数。
400QueryAccountBookInfoFailedFailed to invoke account book info.调用账本信息失败。
400RateAccountFailedFailed to rate account for pricing.调用定价服务失败。
400TradeWaitDistributorAuditThe trade needs distributor to audit.此次交易待经销商审核。
400OperationFailed.InvokeProxyFailedFailed to invoke proxy.操作失败,原因是调用管控失败。
400QueryAccountCompleteProgressFailedFailed to query account progress.查询账户进度失败。
400QueryVoucherInfoFailedFailed to query voucher info.查询凭证信息失败。
400InvalidVSwitchId.NotFoundThe specified vSwitch instance is invalid.非法的vswitch实例。
400IllegalParam.SpecTypeThe param of SpecType is illegal.指定的SpecType无效。请检查参数约束,并在修改后重试。
400MissingParam.SpecTypeThe param of SpecType is missing.参数SpecType缺失。
400UnsupportedRegionThe feature is not supported in current region.当前地域不支持该功能。
400PayInsufficientBalanceYour account balance is insufficient.您的账户余额不足
400IllegalParam.InstanceChargeTypeThe parameter InstanceChargeType is illegal.指定的InstanceChargeType非法。
400SystemBusyThe system is busy.系统繁忙,请您稍后再试。
400PRODUCT.NOT_AVAILABLE_IZThe Instance zone id doesn t support实例可用区ID不支持。
400PRICE.INQUIRY_FAILEDThe instance pricing inquiry is failed.实例定价查询失败。
400AssociateIpFailThe instance associating ip is failed.-
400SDK.ServerUnreachableService is unreachable.暂时无法访问服务,请稍后重试。
400OverQuotaThe Total is over the quota总数超过了限额,请您减少数量后再重试。
400InvalidParam.TagValue %s.-
400InvalidParam.TagKey%s.-
400SizeLimitExceeded.Tag%s.-
400MissingParam.TagKeyThe param MissingParam.TagKey is missing.-
400SubnetIpExhaustNo subnet IP addresses are available.没有可用的子网ip
400BeforePayRuleBatchValidateErrorThe pre-payment rule center instance rule validation failed. Please check if the instance limit has been reached.支付前规则中心实例规则校验不通过,请检查是否到达实例限制。
400TradeSyncCreateSubErrorSubscription transfer failed.转订购失败,请稍后重试。
400QueryOrderErrorFailed to query the order. Please try again later.查询订单失败,请稍后重试。
400CreateOrderTimeoutOrder creation timed out. Please try again later.创建订单超时,请稍后重试。
400MultiGrayKeyResourceInconsistThe identifier for the gray resource is set incorrectly.灰度资源的标识设置错误。
400InsufficientAvailableQuotaYour account available balance is less than 0. Please recharge before attempting to make a purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400Forbidden.AliGroupForbiddenRegionThre region is forbidden for aligroup user.阿里集团生产账号不允许在本区域购买资源。

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

变更历史

变更时间变更内容概要操作
2024-01-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-09-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-06-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-06-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-06-02OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)