CreateIpamPoolAllocation - 從IPAM位址集區建立自訂預留網段 - Virtual Private Cloud

從IPAM位址集區建立自訂預留網段。

介面說明

建立自訂預留網段前，請確保您已經建立了 IPAM 位址集區並為該位址集區添加了 CIDR。您可以通過調用 CreateIpamPool 和 AddIpamPoolCidr 分別建立 IPAM 位址集區並為位址集區添加 CIDR。
指定參數 Cidr 或 CidrMask 建立自訂預留網段時，對應的掩碼需要在 IPAM 位址集區規定的範圍內。
當 IPAM 位址集區具備地區屬性時，建立自訂預留網段的請求需要從位址集區所在的地區發起。
需要建立的自訂預留網段不能和 IPAM 位址集區已建立的 CIDR 分配衝突。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:CreateIpamPoolAllocation

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	要建立的自訂預留網段所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
IpamPoolId	string	是	IPAM 位址集區的執行個體 ID。	ipam-pool-6rcq3tobayc20t****
Cidr	string	否	通過輸入位址區段的方式從 IPAM 位址集區建立自訂預留網段。說明參數 Cidr 或 CidrMask 至少輸入一個。	192.168.1.0/24
CidrMask	integer	否	通過輸入遮罩的方式從 IPAM 位址集區建立自訂預留網段。說明參數 Cidr 或 CidrMask 至少輸入一個。	24
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會建立自訂預留網段。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 DryRunOperation。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接建立。	false
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	123e4567-e89b-12d3-a456-426655440000
IpamPoolAllocationDescription	string	否	自訂預留網段的描述資訊。長度為 1～256 個字元，必須以大小寫英文字母或中文字元開頭，但不能以`http://`或`https://`開頭。不填則為空白，預設值為空白。	test description
IpamPoolAllocationName	string	否	自訂預留網段的名稱。長度為 1～128 個字元，不能以`http://`或`https://`開頭。	test name

返回參數

名稱	類型	描述	樣本值
	object	返回的資訊列表。
RequestId	string	請求 ID。	CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2
IpamPoolAllocationId	string	建立的自訂預留網段的執行個體 ID。	ipam-pool-alloc-112za33e4****
Cidr	string	建立的自訂預留網段。	192.168.1.0/24
SourceCidr	string	源位址區段。	192.168.0.0/16

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2",
  "IpamPoolAllocationId": "ipam-pool-alloc-112za33e4****",
  "Cidr": "192.168.1.0/24",
  "SourceCidr": "192.168.0.0/16"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	OperationDenied.ResourceTypeIsNotCustom	The operation is not allowed because the resource type is not Custom.	操作被拒絕，原因是資源類型不是Custom類型。
400	MissingParam.CidrOrCidrMask	The CIDR or CIDR Mask must be input.	從IPAM位址集區分配資源或查詢可用資源時，請輸入Cidr或CidrMask。
400	OperationDenied.IpamPoolNotInRegion	The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.	操作被拒絕，因為無法從不具備地區屬性的位址集區中建立VPC或為VPC添加附加網段。
400	OperationDenied.RequestRegionInvalid	The operation is not allowed because the request is not invoked in the region of the IPAM pool.	操作被拒絕，因為未在位址集區所在地區調用請求。
400	IllegalParam.Cidr	The specified CIDR is illegal.	指定的CIDR不合法。
400	IllegalParam.CidrMask	The specified CidrMask is illegal.	CidrMask參數不合法。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun校正通過。
400	OperationDenied.AvailableCidrInsufficient	The operation is not allowed because available CIDR is insufficient.	操作被拒絕，原因是可用的CIDR資源不足。
400	OperationDenied.CidrInExcludeCidrs	The operation is not allowed because the input CIDR is within the illegal CIDRs.	操作被拒絕，原因是輸入的CIDR在不合法的CIDR範圍內。
400	OperationDenied.CidrUnavailableInPool	The operation is not allowed because the CIDR is unavailable in the IPAM pool.	操作被拒絕，原因是CIDR在IPAM位址集區中不可用。
404	ResourceNotFound.IpamPool	The dependent IPAM pool is not found.	依賴資源IPAM Pool不存在。

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

變更歷史

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