CreateVSwitchCidrReservation - 建立交換器預留網段 - Virtual Private Cloud

調用CreateVSwitchCidrReservation介面建立交換器預留網段。

介面說明

調用該介面建立交換器預留網段時，請注意以下事項：

VPC 中 IPv4、IPv6 最大預留網段數目均為 100 個。
預留網段不能包含所屬交換器的系統保留地址。
- IPv4 網段：交換器的第 1 個和最後 3 個 IP 位址為系統保留地址
- IPv6 網段：交換器的第 1 個和最後 9 個 IP 位址為系統保留地址。
CreateVSwitchCidrReservation 介面屬於非同步介面，即系統會返回一個執行個體 ID，但該交換器預留網段尚未建立完成，系統背景工作仍在進行中。您可以調用 ListVSwitchCidrReservations 查詢交換器預留網段的建立狀態：
- 當交換器預留網段處於 Assigning 狀態時，表示交換器預留網段正在分配中。
- 當交換器預留網段處於 Assigned 狀態時，表示交換器預留網段已指派。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
Tag	array<object>	否	資源標籤
	object	否	標籤資訊。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。一個標籤鍵最多支援 128 個字元，不能以 aliyun 和 acs:開頭，不能包含`http://`或`https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。最多支援 128 個字元，不能以 aliyun 和 acs:開頭，不能包含`http://`或`https://`。	FinanceJoshua
VSwitchId	string	是	要建立的交換器預留網段所屬的交換器 ID。	vsw-25navfgbue4g****
VSwitchCidrReservationName	string	否	交換器預留網段的名稱。名稱長度為 1~128 個字元，以英文字母或中文開頭，可包含數字、底線（_）和短劃線（-）。不能以`http://`和`https://`開頭。	ReservationName
VSwitchCidrReservationDescription	string	否	交換器預留網段的描述資訊。不填則為空白，預設值為空白。描述長度為 1~256 個字元，以英文字母或中文開頭，不能以`http://`和`https://`開頭。	ReservationDescription
IpVersion	string	否	交換器預留網段的 IP 版本。取值： IPv4 （預設值） IPv6 說明建立 IPv4 預留網段時可以不填寫，建立 IPv6 預留網段時必填。	IPv4
VSwitchCidrReservationMask	string	否	交換器預留網段的掩碼。當 IpVersion 取值為 IPv4 時，交換器預留網段的掩碼長度必須比所屬交換器的 IPv4 網段掩碼大 2 且最大不超過 28。當 IpVersion 取值為 IPv6 時，交換器預留網段的掩碼長度必須要大於所屬交換器的 IPv6 網段掩碼長度且最大不超過 80。說明 VSwitchCidrReservationMask 參數和 VSwitchCidrReservationCidr 參數必須輸入一個。預留網段不能包含所屬交換器的系統保留地址。	28
VSwitchCidrReservationCidr	string	否	交換器預留網段。當 IpVersion 取值為 IPv4 時，交換器預留網段必須是其所屬交換器 IPv4 網段的真子集且網段的掩碼長度不超過 28。當 IpVersion 取值為 IPv6 時，交換器預留網段必須是其所屬交換器 IPv6 網段的真子集且網段的掩碼長度不超過 80。說明 VSwitchCidrReservationMask 參數和 VSwitchCidrReservationCidr 參數必須輸入一個。預留網段不能包含所屬交換器的系統保留地址。	192.168.1.64/28
VSwitchCidrReservationType	string	否	交換器預留網段的類型。取值：prefix，表示按段分配地址。說明使用者及雲端服務自動為彈性網卡 ENI（Elastic Network Interface）分配網段時，必須從預留位址區段分配。如果預留位址區段的地址已經分配完，則系統會報錯。	prefix
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會建立交換器預留網段。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接進行建立。	false
RegionId	string	是	交換器所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	交換器預留網段的執行個體 ID。
VSwitchCidrReservationId	string	交換器預留網段的執行個體 ID。	vcr-bp1m12saqteraw3rp****
RequestId	string	請求 ID。	54B48E3D-DF70-471B-AA93-08E683A1B45

樣本

正常返回樣本

JSON格式

{
  "VSwitchCidrReservationId": "vcr-bp1m12saqteraw3rp****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalParamFormat	IllegalParamFormat	參數格式不正確
400	IllegalParamFormat.VSwitchCidrReservationCidr	The param format of VSwitchCidrReservationCidr is illegal.	VSwitchCidrReservationCidr參數格式非法
400	ResourceNotFound.VSwitch	The specified resource of VSwitch is not found.	指定的VSwitch執行個體不存在
400	UnsupportedFeature.ReservedType	The specified ReservedType is not supported.	指定的ReservedType未支援
400	UnsupportedFeature.VSwitchIpv6	The ipv6 feature of switch is not supported.	指定的VSwitch未開啟Ipv6
400	OperationFailed.VSwitchCidrReservationCidr	The specified VSwitchCidrReservationCidr conflicts with existed cidr reservation or vswitch cidr.	指定的VSwitchCidrReservationCidr與已有的VSwitchCidrReservation網段衝突
400	MissingParam.CidrReservationMaskOrCidrReservationCidr	Either VSwitchCidrReservationMask or VSwitchCidrReservationCidr should be specified.	VSwitchCidrReservationMask和VSwitchCidrReservationCidr不能同時為空白，請指定其中一個重試。
400	UnsupportedRegion	UnsupportedRegion	當前Region未支援該特性
400	UnsupportedFeature.VpcAdvancedFeature	UnsupportedFeature.VpcAdvancedFeature	你指定的VSwitch所在的VPC未支援進階特性，請更換其他VSwitch重試
400	QuotaExceeded.CidrReservationCount	The quota of VSwitchCidrReservation is exceeded.	超過 VSwitchCidrReservation 的數量配額。
400	Conflict.CidrReservationMaskAndCidrReservationCidr	The specified VSwitchCidrReservationMask and VSwitchCidrReservationCidr is conflict.	指定的 VSwitchCidrReservationMask 和 VSwitchCidrReservationCidr 衝突，請根據API文檔參數說明修改後重試。
400	OperationFailed.CidrNotEnoughInVSwitch	No enough cidr to allocate in this vswitch.	指定的vswitch已沒有足夠的cidr分配出CidrReservation。
400	OperationFailed.SystemReservedIpContained	The specified VSwitchCidrReservationCidr cannot contain system reserved IP addresses.	指定的VSwitchCidrReservationCidr不能包含系統預留IP地址
400	OperationFailed.AlreadyUsedIpContained	The specified VSwitchCidrReservationCidr cannot contain already used IP addresses.	指定的預留網段不能包含已被使用的IP地址。
400	IncorrectStatus.VSWITCH	The status of the specified VSwitch is invalid.	虛擬交換器狀態異常。
400	IllegalParam.VSwitchCidrReservationMask	The specified VSwitchCidrReservationMask must be at least 2 bits greater than the vSwitch mask.	指定的 VSwitchCidrReservationMask 至少比 VSwitch 的掩碼大 2。
400	QuotaExceeded.VSwitchCidrReservationMask	The operation is failed because of %s. The mask of the reserved subnet cidr exceeds the current default mask of IP Prefix, %s/%s.	操作失敗因為%s配額的限制。預留網段的掩碼超過了當前IP Prefix的預設掩碼，%s/%s。

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

變更歷史

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