調用CreateVSwitchCidrReservation接口創建交換機預留網段。
接口說明
調用該接口創建交換機預留網段時，請注意以下事項：
- VPC 中單個交換機 IPv4、IPv6 最大預留網段數目均為 10 個。
- 當您在交換機下添加預留網段后，該預留網段不能包含交換機對應的 VPC 的系統保留地址。
- CreateVSwitchCidrReservation 接口屬于異步接口，即系統會返回一個實例 ID，但該交換機預留網段尚未創建完成，系統后臺任務仍在進行中。您可以調用
ListVSwitchCidrReservations 查詢交換機預留網段的創建狀態：
- 當交換機預留網段處于 Assigning 狀態時，表示交換機預留網段正在分配中。
- 當交換機預留網段處于 Assigned 狀態時，表示交換機預留網段已分配。
- 當您分配 IPv4 版本的交換機預留網段時，該交換機的第 1 個和最后 3 個 IP 地址為系統保留地址。這 4 個保留地址不會被分配出去。
- 當您分配 IPv6 版本的交換機預留網段時，該交換機的第 1 個和最后 9 個 IP 地址為系統保留地址。這 10 個保留地址不會被分配出去。 以 IPv4 預留網段為例，例如交換機網段為 192.168.1.0/24，則系統保留地址為 192.168.1.0、192.168.1.253、192.168.1.254 和 192.168.1.255，分配的預留網段中不能包含這 4 個 IP 地址在內。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:CreateVSwitchCidrReservation | create | *VSwitchCidrReservation acs:vpc:{#regionId}:{#accountId}:vswitchcidrreservation/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Tag | array<object> | 否 | 資源標簽 | |
| object | 否 | 標簽信息。 | ||
| Key | string | 否 | 資源的標簽鍵。最多支持輸入 20 個標簽鍵。如需傳入該值，則不能輸入空字符串。 一個標簽鍵最多支持 128 個字符，不能以 aliyun 和 acs:開頭，不能包含 http://或者 https://。 | FinanceDept |
| Value | string | 否 | 資源的標簽值。最多支持輸入 20 個標簽值。如需傳入該值，可以輸入空字符串。 最多支持 128 個字符，不能以 aliyun 和 acs:開頭，不能包含 http://或者 https://。 | FinanceJoshua |
| VSwitchId | string | 是 | 要創建的交換機預留網段所屬的交換機 ID。 | vsw-25navfgbue4g**** |
| VSwitchCidrReservationName | string | 否 | 交換機預留網段的名稱。 名稱長度為 2~128 個字符，以英文字母或中文開頭，可包含數字、下劃線（_）和短劃線（-）。 | ReservationName |
| VSwitchCidrReservationDescription | string | 否 | 交換機預留網段的描述信息。不填則為空，默認值為空。 描述長度為 2~256 個字符，以英文字母或中文開頭，不能以 | ReservationDescription |
| IpVersion | string | 否 | 交換機預留網段的 IP 版本。取值：
| IPv4 |
| VSwitchCidrReservationMask | string | 否 | 交換機預留網段的掩碼。
說明
| 28 |
| VSwitchCidrReservationCidr | string | 否 | 交換機預留網段。
說明
| 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 | 否 | 是否只預檢此次請求。取值：
| false |
| RegionId | string | 是 | 交換機所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
返回參數
示例
正常返回示例
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.VSwitchCidrReservationMask | The quota of VSwitchCidrReservationMask is exceeded. | VSwitchCidrReservationMask 超出配額，請參考API文檔參數說明修改后重試。 |
| 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。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-11-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |