CreateLoadBalancer - 建立Server Load Balancer執行個體 - Server Load Balancer

建立Server Load Balancer執行個體。

介面說明

請確保在使用該介面前，已充分瞭解網關型負載平衡產品的收費方式和價格。

建立網關型Server Load Balancer執行個體時會自動為使用者建立 AliyunServiceRoleForGwlb 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程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gwlb:CreateLoadBalancer

create

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/*

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

無

請求參數

名稱	類型	必填	描述	樣本值
AddressIpVersion	string	否	協議版本。取值： Ipv4（預設值）：Ipv4 類型。	Ipv4
LoadBalancerName	string	否	網關型Server Load Balancer執行個體名稱。長度為 2~128 個英文或中文字元，必須以字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短劃線（-）。	testGwlbName
VpcId	string	是	Virtual Private Cloud ID。	vpc-uf6qcgpv22ttrnnjh****
ZoneMappings	array<object>	是	可用性區域及交換器映射列表。至少需要添加一個可用性區域，最多支援添加 20 個可用性區域。若當前地區支援 2 個及以上的可用性區域，建議添加 2 個及以上可用性區域。
	object	否	可用性區域及交換器映射對象。
VSwitchId	string	是	可用性區域對應的交換器，每個可用性區域只能使用一台交換器和一個子網。	vsw-2f0eb020****
ZoneId	string	是	可用性區域 ID，通過調用網關型負載平衡 DescribeZones 介面獲得。	cn-hangzhou-a
Tag	array<object>	否	標籤列表。
	object	否	標籤列表。一次調用最多支援 20 個標籤。
Key	string	否	標籤鍵。一旦傳入該值，則不允許為空白字串。一個標籤健最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	testTagKey
Value	string	否	標籤值。最多支援 256 個字元，不能包含`http://`或`https://`。	testTagValue
ResourceGroupId	string	否	資源群組 ID。	rg-acfmwbufq6q3****
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會建立執行個體。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接進行操作。	false
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	123e4567-e89b-12d3-a456-42665544****

返回參數

名稱	類型	描述	樣本值
	object
LoadBalancerId	string	網關型Server Load Balancer執行個體的 ID。	gwlb-9njtjmqt7zfcqm****
RequestId	string	請求 ID。	00B19438-66BB-58C3-8C2F-DA5B6F95CBDA

樣本

正常返回樣本

JSON格式

{
  "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
  "RequestId": "00B19438-66BB-58C3-8C2F-DA5B6F95CBDA"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	DuplicatedParam.ZoneId	The param of ZoneId is duplicated.	列表中的ZoneId參數重複
400	OperationDenied.VSwitchNotSupportIpv6	The operation is not allowed because of VSwitchNotSupportIpv6.	交換器vSwitch沒有開啟IPv6，操作不支援
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.	vSwitch IP資源不足
400	DuplicatedParam.VSwitchId	The param of VSwitchId is duplicated.	列表中的vSwitchId參數重複
400	IllegalParamSize.ZoneMappings	The param size of ZoneMappings is illegal.	ZoneMappings列表數量不合法
400	Mismatch.ZoneIdAndVSwitchId	The ZoneId and VSwitchId are mismatched.	參數ZoneId和vSwitchId的值不匹配
400	QuotaExceeded.LoadBalancersNum	The quota of %s is exceeded for resource %s, usage %s/%s.	配額gwlb_quota_loadbalancers_num已超額度限制。
400	DuplicatedParam.TagKey	The param of %s is duplicated.	標籤鍵參數重複
400	IllegalParam.TagKey	The param of %s is illegal.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。