建立網路型Server Load Balancer執行個體。
介面說明
建立網路型Server Load Balancer執行個體時會自動為使用者建立 AliyunServiceRoleForNlb SLR 角色。
- CreateLoadBalancer 介面屬於非同步介面,即系統返回一個執行個體 ID,但該網路型Server Load Balancer執行個體尚未建立成功,系統背景建立任務仍在進行。您可以調用 GetLoadBalancerAttribute 查詢網路型Server Load Balancer執行個體的建立狀態:
當網路型Server Load Balancer執行個體處於 Provisioning 狀態時,表示網路型Server Load Balancer執行個體正在建立中。
當網路型Server Load Balancer執行個體處於 Active 狀態時,表示網路型Server Load Balancer執行個體建立成功。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
nlb:CreateLoadBalancer |
create |
*LoadBalancer
*VSwitch
EipAddress
*VPC
|
|
無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| LoadBalancerType |
string |
否 |
負載平衡的類型,僅取值:network,表示網路型負載平衡。 |
network |
| LoadBalancerName |
string |
否 |
網路型Server Load Balancer執行個體名稱。 長度為 2~128 個英文或中文字元,必須以大小寫英文字母或中文開頭,可包含數字、半形句號(.)、底線(_)和短劃線(-)。 |
NLB1 |
| AddressType |
string |
是 |
網路型Server Load Balancer執行個體的 IPv4 地址類型。取值:
說明
網路型負載平衡雙棧執行個體的 IPv6 公網需通過 EnableLoadBalancerIpv6Internet 介面開啟。 |
Internet |
| AddressIpVersion |
string |
否 |
協議版本。取值:
|
ipv4 |
| VpcId |
string |
是 |
網路型Server Load Balancer執行個體的專用網路 ID。 |
vpc-bp1b49rqrybk45nio**** |
| ZoneMappings |
array<object> |
是 |
可用性區域及交換器映射列表。最多支援添加 10 個可用性區域。若當前地區支援 2 個及以上的可用性區域,至少需要添加 2 個可用性區域。 |
|
|
object |
否 |
可用性區域及交換器映射列表。最多支援添加 10 個可用性區域。若當前地區支援 2 個及以上的可用性區域,至少需要添加 2 個可用性區域。 |
||
| VSwitchId |
string |
是 |
可用性區域對應的交換器,每個可用性區域只能使用一台交換器和一個子網。最多支援添加 10 個可用性區域。 若當前地區支援 2 個及以上的可用性區域,至少需要添加 2 個可用性區域。 |
vsw-sersdf**** |
| ZoneId |
string |
是 |
網路型Server Load Balancer執行個體的可用性區域 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 |
否 |
網路型Server Load Balancer執行個體計費配置。 |
|
| PayType |
string |
否 |
網路型Server Load Balancer執行個體的計費類型。 僅取值 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 |
否 |
網路型Server Load Balancer執行個體所在的地區 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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
response |
||
| RequestId |
string |
請求 ID。 |
CEF72CEB-54B6-4AE8-B225-F876FF7BA984 |
| LoadbalancerId |
string |
執行個體 ID。 |
nlb-83ckzc8d4xlp8o**** |
| OrderId |
integer |
網路型Server Load Balancer執行個體的訂單 ID。 |
20230000 |
樣本
正常返回樣本
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.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資源,請檢查輸入參數。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。