創建網絡型負載均衡實例。
接口說明
- 創建網絡型負載均衡實例時會自動為用戶創建 AliyunServiceRoleForNlb SLR 角色。
- CreateLoadBalancer 接口屬于異步接口,即系統返回一個實例 ID,但該網絡型負載均衡實例尚未創建成功,系統后臺的創建任務仍在進行。您可以調用 GetLoadBalancerAttribute 查詢網絡型負載均衡實例的創建狀態:
- 當網絡型負載均衡實例處于 Provisioning 狀態時,表示網絡型負載均衡實例正在創建中。
- 當網絡型負載均衡實例處于 Active 狀態時,表示網絡型負載均衡實例創建成功。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
nlb:CreateLoadBalancer | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
LoadBalancerType | string | 否 | 負載均衡的類型,僅取值:network,表示網絡型負載均衡。 | network |
LoadBalancerName | string | 否 | 網絡型負載均衡實例名稱。 長度為 2~128 個英文或中文字符,必須以大小寫英文字母或中文開頭,可包含數字、半角句號(.)、下劃線(_)和短劃線(-)。 | NLB1 |
AddressType | string | 是 | 網絡型負載均衡實例的 IPv4 地址類型。取值:
說明
網絡型負載均衡雙棧實例的 IPv6 公網需通過 EnableLoadBalancerIpv6Internet 接口開啟。
| Internet |
AddressIpVersion | string | 否 | 協議版本。取值:
| ipv4 |
VpcId | string | 是 | 網絡型負載均衡實例的專有網絡 ID。 | vpc-bp1b49rqrybk45nio**** |
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 |
PrivateIPv4Address | string | 否 | IPv4 私網 VIP 地址。NLB 對外提供服務的私網 IPv4 地址。 | 192.168.10.1 |
AllocationId | string | 否 | 公網實例綁定的 EIP 實例 ID,每個可用區對應 1 個 EIP 實例 ID。最多支持添加 10 個可用區。若當前地域支持 2 個及以上可用區,至少需要添加 2 個可用區。 | eip-bp1aedxso6u80u0qf**** |
Ipv6Address | string | 否 | IPv6 VIP 地址。NLB 對外提供服務的 IPv6 地址。 | 2408:400a:d5:3080:b409:840a:ca:e8e5 |
Ipv4LocalAddresses | array | 否 | IPv4 Local 地址列表。NLB 與后端服務交互的地址列表。 地址個數必須是偶數,且最少 2 個,最多 8 個。 | |
string | 否 | IPv4 Local 地址。 | 192.168.10.2 | |
Ipv6LocalAddresses | array | 否 | IPv6 Local 地址列表。NLB 與后端服務交互的地址列表。 地址個數必須是偶數,且最少 2 個,最多 8 個。 | |
string | 否 | IPv6 Local 地址。 | 2408:400a:d5:3080:b409:840a:ca:e8e6 | |
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 | array<object> | 否 | 標簽列表。 | |
object | 否 | 標簽。 | ||
Key | string | 否 | 標簽鍵。最多支持 64 個字符,不能以 一次調用最多支持添加 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中使用的可用區非法。 |
400 | QuotaExceeded.QuotaInsufficient | The quota of %s is exceeded, usage %s/%s. | 配額不足,已使用%s/%s。請在配額中心中修改配額大小。 |
400 | ResourceInUse.IP | The specified resource of IP is in use. | 傳入的IP不能是NLB的eni地址,請檢查參數。 |
400 | OperationFailed.CreateOrderError | Operation failed because CreateOrderError. | 因為創建訂單失敗,所以操作失敗。 |
400 | OperationFailed.NotExist.ResourceGroup | Operation failed because ResourceGroup not exist. | 指定的資源組不存在。 |
400 | IllegalParam.loadBalancerName | Param loadBalancerName is illegal. | 實例名稱非法,請檢查參數。 |
400 | SystemBusy | System is busy, please try again later. | 系統繁忙,請稍后重試 |
400 | MissingParam.%s | The parameter of %s is missing. | 參數%s缺失,請檢查輸入參數。 |
400 | IllegalParam.loadBalancerName | The parameter loadBalancerName of listener is illegal. | NLB負載均衡實例名稱不符合輸入要求,請根據錯誤中的詳細信息進行修改。 |
400 | IllegalParam.DeletionProtectionConfig | DeletionProtectionConfig reason is illegal. | 更改刪除保護狀態原因參數非法。 |
400 | IllegalParam.ModificationProtectionConfig | ModificationProtectionConfig reason is illegal. | 修改保護原因參數非法。 |
400 | Throttling.User | Request was denied due to api flow control. | 由于觸發流控,請求被拒絕。 |
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資源,請檢查輸入參數。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-02-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-02-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-02-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-11-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-10-09 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
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 入參發生變更 | 查看變更詳情 |