CreateIpam - 建立一個IPAM執行個體 - Virtual Private Cloud

建立一個IPAM執行個體。

介面說明

每個阿里雲帳號（主帳號）在每個地區只支援建立 1 個 IPAM。
目前，IPAM 僅支援分配 IPv4 類型的 IP 位址。
建立 IPAM 執行個體時：
- 若使用者在當前地區不存在自訂類型的資摘要搜索執行個體，系統會直接建立與 IPAM 執行個體關聯的預設資摘要搜索執行個體。
- 若使用者在當前地區已經存在自訂類型的資摘要搜索執行個體，系統會將該資摘要搜索轉化為預設資摘要搜索，並建立與 IPAM 執行個體的關聯關係。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:CreateIpam

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	IPAM 託管地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
IpamName	string	否	IPAM 的名稱。長度為 1～128 個字元，不能以`http://`或`https://`開頭。	abc
OperatingRegionList	array	是	IPAM 生效地區列表。
	string	否	IPAM 的生效地區。說明支援選擇一個或多個地區。	cn-hangzhou
IpamDescription	string	否	IPAM 的描述資訊。長度為 1～256 個字元，必須以大小寫字母或中文開頭，但不能以`http://`和`https://`開頭。描述不填則為空白，預設值為空白。	This is my first Ipam
ResourceGroupId	string	否	IPAM 的資源群組 ID。	rg-acfmxazb4ph6aiy****
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會建立 IPAM。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 DryRunOperation。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接建立 IPAM。	false
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	123e4567-e89b-12d3-a456-426655440000
Tag	array<object>	否	標籤列表資訊。
	object	否	標籤列表資訊。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。一旦傳入該值，則不允許為空白字串。最多支援 64 個字元，必須以字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短劃線（-），不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。一旦傳入該值，可以為空白字串。最多支援 128 個字元，不能包含`http://`或者`https://`。	FinanceJoshua

返回參數

名稱	類型	描述	樣本值
	object	返回的資訊列表。
RequestId	string	請求 ID。	0ED8D006-F706-4D23-88ED-E11ED39DCAC0
IpamId	string	IPAM 的執行個體 ID。	ipam-ccxbnsbhew0d6t****
PrivateDefaultScopeId	string	建立 IPAM 後，系統預設建立的私網 IPAM 作用範圍。	ipam-scope-8wiontzmiy6cg0****
PublicDefaultScopeId	string	建立 IPAM 後，系統預設建立的公網 IPAM 作用範圍。	ipam-scope-r5c5c7bmym1brc****
DefaultResourceDiscoveryId	string	預設資摘要搜索執行個體 ID。	ipam-res-disco-jt5f2af2u6nk2z321****
DefaultResourceDiscoveryAssociationId	string	預設的資摘要搜索關聯關係 ID。	ipam-res-disco-assoc-jt5fac8twugdbbgip****
ResourceDiscoveryAssociationCount	integer	資摘要搜索數量。	1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED39DCAC0",
  "IpamId": "ipam-ccxbnsbhew0d6t****",
  "PrivateDefaultScopeId": "ipam-scope-8wiontzmiy6cg0****",
  "PublicDefaultScopeId": "ipam-scope-r5c5c7bmym1brc****",
  "DefaultResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****",
  "DefaultResourceDiscoveryAssociationId": "ipam-res-disco-assoc-jt5fac8twugdbbgip****",
  "ResourceDiscoveryAssociationCount": 1
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	UnsupportedRegion.Ipam	Ipam is not supported in this region.	該地區不支援IPAM。
400	QuotaExceeded.IpamQuotaPerRegion	The quota of ipamQuotaPerRegion count is exceeded.	IPAM允許的最大數量超過限制。
400	IllegalParam.OperatingRegion	The operating region is invalid.	生效地區非法。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun校正通過。
400	OperationFailed.OperatingRegionsNeedIncludeIpamRegion	The operating regions do not contain IPAM region.	操作地區未包含IPAM託管地區。
400	UnsupportedFeature.Ipam	IPAM is not supported in this region.	該地區不支援IPAM功能。
400	OptInRequired.Ipam	You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use.	您無權使用請求的 IPAM 服務。確保您已經訂閱了您嘗試使用的服務。

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

變更歷史

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