幫助中心
首頁 Virtual Private Cloud 開發參考 API參考 API目錄 交換器 CheckCanAllocateVpcPrivateIpAddress - 查詢交換器下的私網IP可用性

CheckCanAllocateVpcPrivateIpAddress - 查詢交換器下的私網IP可用性

更新時間：
Copy as MD
產品

調用CheckCanAllocateVpcPrivateIpAddress介面查詢交換器下的私網IP地址是否可用。

介面說明

  • 每個交換器的第 1 個和最後 3 個 IPv4 地址為系統保留地址，第 1 個和最後 9 個 IPv6 地址為系統保留地址，不允許分配。

調試

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

調試

授權資訊

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

  • 操作：是指具體的許可權點。

  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

  • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

    • 對於必選的資源類型，用前面加 * 表示。

    • 對於不支援資源級授權的操作，用全部資源表示。

  • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

  • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:CheckCanAllocateVpcPrivateIpAddress

none

*VSwitch

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

 無 無

請求參數

名稱

類型

必填

描述

樣本值
RegionId

string

是

要查詢的私網 IP 位址所屬交換器的地區 ID。

您可以通過調用 DescribeRegions 介面擷取地區 ID。

cn-qingdao
VSwitchId

string

是

要查詢的私網 IP 位址所屬的交換器 ID。

vsw-m5ew3t46z2drmifnt****
PrivateIpAddress

string

是

要查詢是否可用的私網 IP 位址，該私網 IP 位址必須屬於 VSwitchId 參數中輸入的交換器。

10.0.0.7
IpVersion

string

否

要查詢的私網 IP 位址的類型。取值：

  • ipv4：IPv4 類型。當查詢的私網 IP 位址為 IPv4 類型時，該參數為選填。

  • ipv6：IPv6 類型。當查詢的私網 IP 位址為 IPv6 類型時，該參數為必填。

ipv4

返回參數

名稱

類型

描述

樣本值

object

Schema object

CanAllocate

boolean

查詢的私網 IP 位址是否可用。取值：

  • true：指定交換器下，該私網 IP 位址沒有被佔用，可以使用。

  • false：指定交換器下，該私網 IP 位址已被佔用，無法使用。

true
RequestId

string

請求 ID。

93360B0-2969-40BF-8542-EBB34FD358AB

樣本

正常返回樣本

JSON格式

{
  "CanAllocate": true,
  "RequestId": "93360B0-2969-40BF-8542-EBB34FD358AB"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述
400 PARAMETER_ILLEGAL Parameter illegal.Parameter is ipVersion
400 ResourceNotFound.VSwitchId The specified resource vswitch is not found.
400 Mismatch.VSwitchAndPrivateIpAddress The vswitch and privateIpAddress are mismatched. 當前指定的私網IP和交換器不匹配。
400 IllegalParam.PrivateIpAddress The specified PrivateIpAddress is illegal. 指定的PrivateIpAddress無效。請檢查參數約束，並在修改後重試。

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

變更歷史

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

上一篇：CreateDefaultVSwitch下一篇：DeleteVSwitch