在指定地域創建應用型負載均衡實例。
接口說明
CreateLoadBalancer 接口屬于異步接口,即系統返回一個實例 ID,但該應用型負載均衡實例尚未創建成功,系統后臺的創建任務仍在進行。您可以調用 GetLoadBalancerAttribute 查詢應用型負載均衡實例的創建狀態:
- 當應用型負載均衡實例處于 Provisioning 狀態時,表示應用型負載均衡實例正在創建中。
- 當應用型負載均衡實例處于 Active 狀態時,表示應用型負載均衡實例創建成功。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
alb:CreateLoadBalancer | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
DryRun | boolean | 否 | 是否只預檢此次請求,取值:
| false |
VpcId | string | 是 | 應用型負載均衡實例的專有網絡 ID。 | vpc-bp1b49rqrybk45nio**** |
AddressType | string | 是 | 應用型負載均衡的地址類型。取值:
| Internet |
LoadBalancerName | string | 否 | 應用型負載均衡實例名稱。 長度為 2~128 個英文或中文字符,必須以字母或中文開頭,可包含數字、半角句號(.)、下劃線(_)和短劃線(-)。 | alb1 |
DeletionProtectionEnabled | boolean | 否 | 是否開啟刪除保護。取值:
| false |
ModificationProtectionConfig | object | 否 | 修改保護配置。 | |
Reason | string | 否 | 輸入開啟修改保護的原因。長度為 2~128 個英文或中文字符,必須以字母或中文開頭,可包含數字、半角句號(.)、下劃線(_)和短劃線(-)。 說明
僅在 Status 為 ConsoleProtection 時該參數有效且合法。
| 托管實例 |
Status | string | 否 | 修改應用型負載均衡實例的修改保護狀態。取值:
說明
當取值為 ConsoleProtection,即開啟修改保護后,用戶不能通過負載均衡控制臺修改實例配置,但可以通過調用 API 修改實例配置。
| ConsoleProtection |
ZoneMappings | array<object> | 是 | 可用區及交換機映射列表,最多支持添加 10 個可用區。若當前地域支持 2 個及以上的可用區,至少需要添加 2 個可用區。 | |
object | 是 | 可用區及交換機映射列表,最多支持添加 10 個可用區。若當前地域支持 2 個及以上的可用區,至少需要添加 2 個可用區。 | ||
VSwitchId | string | 是 | 可用區對應的交換機,每個可用區只能使用一臺交換機和一個子網。最多支持添加 10 個可用區。若當前地域支持 2 個及以上的可用區,至少需要添加 2 個可用區。 | vsw-sersdf**** |
ZoneId | string | 是 | 可用區 ID。最多支持添加 10 個可用區。若當前地域支持 2 個及以上的可用區,至少需要添加 2 個可用區。 您可以通過調用 DescribeZones 接口獲取可用區 ID 對應的可用區的信息。 | cn-hangzhou-a |
AllocationId | string | 否 | 公網實例綁定的 EIP 實例 ID。 | eip-bp1aedxso6u80u0qf**** |
EipType | string | 否 | Common | |
IntranetAddress | string | 否 | IPv4 私網地址。 | 192.168.10.1 |
AddressAllocatedMode | string | 否 | 地址模式。取值 :
| Dynamic |
ResourceGroupId | string | 否 | 企業資源組 ID。 | rg-atstuj3rtop**** |
LoadBalancerEdition | string | 是 | 應用型負載均衡的版本,不同版本有不同功能限制和計費策略。取值:
| Standard |
LoadBalancerBillingConfig | object | 是 | 應用型負載均衡實例計費配置。 | |
PayType | string | 是 | 實例的計費類型。 僅取值 PostPay:表示按量計費。 | PostPay |
BandwidthPackageId | string | 否 | 公網類型實例關聯的共享帶寬包 ID。 | cbwp-bp1vevu8h3ieh**** |
AddressIpVersion | string | 否 | 協議版本。取值:
| IPv4 |
Tag | array<object> | 否 | 標簽。 | |
object | 否 | 標簽結構。 | ||
Key | string | 否 | 最多支持 128 個字符,不能以 aliyun 或 acs:開頭,不能包含 http://或 https://。 | env |
Value | string | 否 | 最多支持 128 個字符,不能以 aliyun 或 acs:開頭,不能包含 http://或 https://。 | product |
返回參數
示例
正常返回示例
JSON
格式
{
"LoadBalancerId": "alb-o9ulmq5hqn68jk****",
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ResourceNotEnough.VSwitchIp | The specified resource %s is not enough. | 資源%s不足。 |
400 | QuotaExceeded.LoadBalancersNum | The quota of %s is exceeded, usage %s/%s. | 配額%s已超額度限制,目前已使用%s,配額為%s。 |
400 | Mismatch.ZoneIdAndVSwitchId | The %s and %s are mismatched. | %s和%s不匹配。 |
400 | DuplicatedParam.ZoneId | The param of ZoneId is duplicated. | 參數ZoneId重復 |
400 | OperationDenyed.ServiceLinkedRoleNotExist | The service linked role AliyunServiceRoleForAlb does not exist. | 用戶沒有SLR |
404 | ResourceNotFound.VSwitch | The specified resource %s is not found. | 資源%s不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-23 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-11-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-10-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |