創建負載均衡實例。
接口說明
注意事項
說明
CLB 包年包月實例 2024 年 12 月 01 日 00:00:00 起停止新購。詳細信息請參見傳統型負載均衡 CLB 包年包月停售公告。
- 實例創建前，請調用 DescribeAvailableResource 查詢可用區支持的資源售賣情況。
- 實例創建后，會產生費用。
- 按量付費模式支持創建按規格計費實例和按使用量計費實例。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| slb:CreateLoadBalancer | create | *LoadBalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 傳統型負載均衡實例的地域 ID。 您可以通過調用 DescribeRegions 接口查詢地域 ID。 | cn-hangzhou |
| AddressType | string | 否 | 傳統型負載均衡實例的網絡類型。取值：
| internet |
| InternetChargeType | string | 否 | 公網類型實例的付費方式。取值：
說明
當 PayType 取值 PayOnDemand 且 InstanceChargeType 取值 PayByCLCU 時，該參數僅支持取值 paybytraffic。
| paybytraffic |
| Bandwidth | integer | 否 | 監聽的帶寬峰值，單位：Mbps。 取值范圍：1～5120。對于按帶寬計費的公網負載均衡實例，可以設置每個監聽的帶寬峰值，但所有監聽的帶寬峰值之和不能超過實例的帶寬峰值。 | 10 |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 由客戶端生成該參數值，要保證在不同請求間唯一。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3 |
| LoadBalancerName | string | 否 | 傳統型負載均衡實例的名稱。 長度為 1～80 個英文或中文字符，必須以大小寫字母或中文開頭，可包含數字、半角句號（.）、下劃線（_）和短劃線（-）。 不指定該參數時，默認由系統分配一個實例名稱。 | lb-bp1o94dp5i6ea**** |
| VpcId | string | 否 | 傳統型負載均衡實例的所屬的 VPC ID。 | vpc-bp1aevy8sofi8mh1**** |
| VSwitchId | string | 否 | 專有網絡實例的所屬的交換機 ID。 創建專有網絡類型的負載均衡實例，必須指定該參數。如果指定了該參數，AddessType 參數的值會默認被設置為 intranet。 | vsw-bp12mw1f8k3jgy**** |
| MasterZoneId | string | 否 | 傳統型負載均衡實例的主可用區 ID。 您可以通過調用 DescribeZone 接口可查到相應地域下的主備可用區信息。 | cn-hangzhou-b |
| SlaveZoneId | string | 否 | 傳統型負載均衡實例的備可用區 ID。 您可以通過調用 DescribeZone 接口查詢相應地域下的主備可用區信息。 | cn-hangzhou-d |
| LoadBalancerSpec | string | 否 | 傳統型負載均衡實例的規格。取值：
說明
若不指定規格，則創建性能共享型實例。目前，共享型實例已停止售賣，請指定實例規格。
當 InstanceChargeType 取值為 PayByCLCU，該參數不生效，您無需配置該參數。 | slb.s1.small |
| ResourceGroupId | string | 否 | 企業資源組 ID。 | rg-atstuj3rtopt**** |
PayTypedeprecated | string | 否 | 實例的計費類型，取值：
| PayOnDemand |
PricingCycledeprecated | string | 否 | 預付費公網實例的計費周期，取值：
說明
該參數僅適用于中國站且僅對包年包月實例有效。
| month |
Durationdeprecated | integer | 否 | 預付費公網實例的購買時長，取值：
說明
該參數僅適用于中國站且僅對包年包月實例有效。
| 1 |
AutoPaydeprecated | boolean | 否 | 是否是自動支付預付費公網實例的賬單。取值：
說明
該參數僅適用于中國站且僅對包年包月實例有效。
| true |
| AddressIPVersion | string | 否 | 傳統型負載均衡實例的 IP 版本，取值：ipv4 或 ipv6。 | ipv4 |
| Address | string | 否 | 指定實例的私網 IP 地址，該地址必須包含在交換機的目標網段下。 | 192.168.XX.XX |
| Tag | array<object> | 否 | 標簽列表。 | |
| object | 否 | 標簽列表。 | ||
| Key | string | 否 | 實例的標簽鍵。N 的取值范圍：1~20。一旦輸入該值，則不允許為空字符串。 最多支持 64 個字符，不能以 | test |
| Value | string | 否 | 實例的標簽值。N 的取值范圍：1~20。一旦輸入該值，可以為空字符串。
最多支持 128 個字符，不能以 | value |
| DeleteProtection | string | 否 | 是否開啟實例刪除保護。取值：
| on |
| ModificationProtectionStatus | string | 否 | 傳統型負載均衡修改保護狀態：
說明
當取值為 ConsoleProtection，即開啟修改保護后，用戶不能通過負載均衡控制臺修改實例配置，但可以通過調用 API 修改實例配置。
| ConsoleProtection |
| ModificationProtectionReason | string | 否 | 設置修改保護狀態的原因，長度為 1～80 個字符，必須以字母或中文開頭，支持數字、半角句號（.）、下劃線（_）和短劃線（-）。 說明
僅在 ModificationProtectionStatus 為 ConsoleProtection 時有效。
| Managed instance |
| InstanceChargeType | string | 否 | 實例計費方式。取值：
說明
該參數僅適用于中國站且僅當 PayType（實例付費模式）取值為 PayOnDemand（按量付費）時，該參數生效。
| PayBySpec |
返回參數
示例
正常返回示例
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 | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | OperationFailed.ZoneResourceLimit | The operation failed because of resource limit of the specified zone. | 操作失敗，原因是當前可用區資源不足。 |
| 400 | CloudBoxNotSupportIpv6 | The cloudBox instance does not support ipv6. | 云盒實例不支持ipv6 |
| 400 | CloudBoxNotSupportInternet | The cloudBox instance does not support internet. | 云盒實例不支持internet |
| 400 | OperationFailed.RegionResourceLimit | The operation failed because of resource limit of the specified region. | 操作失敗，原因是指定地域資源不足。 |
| 400 | Operation.NotAllowed | Operation Denied. The charge type of internet prepay instance can only be paybybandwidth. | 操作被拒絕，原因是公網預付費實例只支持按帶寬計費。 |
| 400 | Operation.NotAllowed | Operation Denied. The charge type of intranet prepay instance can only be paybytraffic. | 操作被拒絕，原因是私網預付費實例只支持按流量計費。 |
| 400 | OperationFailed.UnpaidBillsExist | The account has unpaid bills. Please pay your overdue bill first. | 操作失敗，原因是當前賬戶下存在未支付賬單。請先支付您的逾期賬單。 |
| 400 | RegionOrZonesNotSupportIpv6 | The specified region or master/slave zones does not support ipv6. | 指定地域或主備可用區不支持Ipv6。 |
| 400 | InvalidParameter.Mismatch | AddressType and IpVersion is conflict, IPv6 does not support intranet instance. | 網絡類型和IP版本沖突，私網實例不支持IPv6。 |
| 400 | PAYFOR.CREDIT_PAY_INSUFFICIENT_BALANCE | Your account does not have enough balance. | - |
| 400 | HighRiskOperationDenied | The operation is denied because of high risk. | 操作被拒絕，原因是當前操作為高危操作。 |
| 400 | VSwitchAvailableIpNotExist | The specified VSwitch has no availabe ip. | 指定的交換機沒有可用的Ip。 |
| 400 | VSwitchNotExist | The specified VSwitch does not exist. | 指定的交換機不存在。 |
| 400 | InvalidParameter | Illegal parameter. The IP address is not in subnet. | 參數非法，IP地址不在子網中。 |
| 400 | Instance.ShareSlbNotSupportPay95 | Illegal parameter. The share instance not support PayBy95 or PayByOld95. | 共享型實例不支持PayBy95或PayByOld95。 |
| 400 | Instance.Pay95RateInvalid | Illegal parameter. The rate is illegal. | 指定的Rate無效。請檢查參數約束，并在修改后重試。 |
| 400 | Instance.Pay95BandwidthIllegal | Illegal parameter. The bandwidth is illegal. | 指定的Bandwidth無效。請檢查參數約束，并在修改后重試。 |
| 400 | Instance.InternetChargeTypeNotAllowed | Illegal parameter. The specified InternetChargeType not allowed. | 參數非法，指定的InternetChargeType不支持。 |
| 400 | OperationFailed.TokenIsProcessing | The operation is failed, because the Client Token is processing. | 操作失敗，原因是當前請求正在處理中。 |
| 400 | InsufficientBalance | Your account does not have enough balance. | 賬戶余額不足，請先充值再操作。 |
| 400 | MissingParam.VSwitchId | The parameter VSwitchId is required. | 參數VSwitchId缺失。 |
| 400 | InvalidVpcId.NotExist | The specified VPC not exist. | 指定的VPC不存在。 |
| 400 | PAY.MAYI_WITHHOLDING_AGREEMENT_ILLEGAL | Your account did not sign a withholding agreement or no coupons in Alipay. | - |
| 400 | InvalidParameter.CloudType | The specified CloudType is invalid. | 指定的CloudType無效。請檢查參數約束，并在修改后重試。 |
| 400 | OperationFailed.InvalidAccount | The account information is incomplete. | 操作失敗，原因是賬戶信息不完整。 |
| 400 | RegionOrZonesNotSupportCEN | The specified region or master/slave zones does not support cloudType of hybrid_cen. | 指定的地域或主備可用區不支持CEN。 |
| 400 | MissingParam.LoadBalancerSpec | The param LoadBalancerSpec is required. | 參數LoadBalancerSpec缺失。 |
| 400 | InvalidParameter.Bandwidth | The param Bandwidth is invalid. | 指定的Bandwidth無效。請檢查參數約束，并在修改后重試。 |
| 400 | OperationForbidden.AccountRiskReject | The operation failed because of account risk reject. | 操作失敗，原因是當前賬戶已被風控。 |
| 400 | OperationForbidden.QuotaLimit | The operation failed because of quota limit of shared loadbalancers. | 操作失敗，原因是共享性實例數量已達配額上限。 |
| 400 | InvalidParam.ModificationProtectionStatus | The param ModificationProtectionStatus is invalid. | 指定的ModificationProtectionStatus無效。請檢查參數約束，并在修改后重試。 |
| 400 | InvalidParam.ModificationProtectionReason | The param ModificationProtectionReason is invalid. | 指定的ModificationProtectionReason無效。請檢查參數約束，并在修改后重試。 |
| 400 | InvalidParam.ModificationProtectionReason | %s. | 指定的ModificationProtectionReason無效。請檢查參數約束，并在修改后重試。 |
| 400 | ShareSlbHaltSales | The share instance has been discontinued. | 共享型負載均衡實例已售罄。 |
| 400 | OperationFailed.CashBookInsufficient | No payment method is specified for your account, We recommend that you add a payment method or maintain a prepayment balance. | 操作失敗，原因是您的賬戶未指定付款方式，我們建議您添加付款方式或保持預付款余額。 |
| 400 | OperationFailed.OnlyInnerCommoditySupportToPurchase | AliCroup2Cloud user only can buy inner commodity. | 操作失敗，原因是集團上云用戶只能購買內部商品。 |
| 400 | OperationFailed.InvokeLingXiaoFailed | Failed to invoke lingxiao service. | 操作失敗，原因是調用凌霄服務失敗。 |
| 400 | AllocateVpcInstanceFailed | Failed to allocate vpc instance. | 分配VPC實例失敗。 |
| 400 | QueryCreditCtrlInfoFailed | Failed to query credit ctrl info. | 查詢用戶信息失敗。 |
| 400 | QueryCommodityCenterFailed | Failed to query commodity center. | 商品中心查詢失敗。 |
| 400 | RegionNotSupportParameter | Current region does not support the param of %s. | 當前地域不支持指定參數。 |
| 400 | QueryAccountBookInfoFailed | Failed to invoke account book info. | 調用賬本信息失敗。 |
| 400 | RateAccountFailed | Failed to rate account for pricing. | 調用定價服務失敗。 |
| 400 | TradeWaitDistributorAudit | The trade needs distributor to audit. | 此次交易待經銷商審核。 |
| 400 | OperationFailed.InvokeProxyFailed | Failed to invoke proxy. | 操作失敗，原因是調用管控失敗。 |
| 400 | QueryAccountCompleteProgressFailed | Failed to query account progress. | 查詢賬戶進度失敗。 |
| 400 | QueryVoucherInfoFailed | Failed to query voucher info. | 查詢憑證信息失敗。 |
| 400 | InvalidVSwitchId.NotFound | The specified vSwitch instance is invalid. | 非法的vswitch實例。 |
| 400 | IllegalParam.SpecType | The param of SpecType is illegal. | 指定的SpecType無效。請檢查參數約束，并在修改后重試。 |
| 400 | MissingParam.SpecType | The param of SpecType is missing. | 參數SpecType缺失。 |
| 400 | UnsupportedRegion | The feature is not supported in current region. | 當前地域不支持該功能。 |
| 400 | PayInsufficientBalance | Your account balance is insufficient. | 您的賬戶余額不足 |
| 400 | IllegalParam.InstanceChargeType | The parameter InstanceChargeType is illegal. | 指定的InstanceChargeType非法。 |
| 400 | SystemBusy | The system is busy. | 系統繁忙，請您稍后再試。 |
| 400 | PRODUCT.NOT_AVAILABLE_IZ | The Instance zone id doesn t support | 實例可用區ID不支持。 |
| 400 | PRICE.INQUIRY_FAILED | The instance pricing inquiry is failed. | 實例定價查詢失敗。 |
| 400 | AssociateIpFail | The instance associating ip is failed. | - |
| 400 | SDK.ServerUnreachable | Service is unreachable. | 暫時無法訪問服務，請稍后重試。 |
| 400 | OverQuota | The Total is over the quota | 總數超過了限額，請您減少數量后再重試。 |
| 400 | InvalidParam.TagValue | %s. | - |
| 400 | InvalidParam.TagKey | %s. | - |
| 400 | SizeLimitExceeded.Tag | %s. | - |
| 400 | MissingParam.TagKey | The param MissingParam.TagKey is missing. | - |
| 400 | SubnetIpExhaust | No subnet IP addresses are available. | 沒有可用的子網ip |
| 400 | BeforePayRuleBatchValidateError | The pre-payment rule center instance rule validation failed. Please check if the instance limit has been reached. | 支付前規則中心實例規則校驗不通過，請檢查是否到達實例限制。 |
| 400 | TradeSyncCreateSubError | Subscription transfer failed. | 轉訂購失敗，請稍后重試。 |
| 400 | QueryOrderError | Failed to query the order. Please try again later. | 查詢訂單失敗，請稍后重試。 |
| 400 | CreateOrderTimeout | Order creation timed out. Please try again later. | 創建訂單超時，請稍后重試。 |
| 400 | MultiGrayKeyResourceInconsist | The identifier for the gray resource is set incorrectly. | 灰度資源的標識設置錯誤。 |
| 400 | InsufficientAvailableQuota | Your account available balance is less than 0. Please recharge before attempting to make a purchase. | 您的賬戶可用額度小于0，請先充值后再嘗試購買。 |
| 400 | Forbidden.AliGroupForbiddenRegion | Thre region is forbidden for aligroup user. | 阿里集團生產賬號不允許在本區域購買資源。 |
| 403 | SecurityRisk.AuthVerification | We have detected a security risk with your payment method. Please proceed with verification via the link in your email or console message and re-submit your order after verification. | 系統檢測到您的支付方式存在風險，請通過郵件或站內信中的鏈接完成驗證。驗證完成后重新下單。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-01-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-09-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-09-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-06-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-06-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-06-02 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |