CreateIpamScope - 建立IPAM作用範圍 -

建立私網和公網IPAM作用範圍，分別用於管理私網和公網地址。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:CreateIpamScope

create

*全部資源

*

無

請求參數

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

返回參數

名稱	類型	描述	樣本值
	object	返回的資訊列表。
RequestId	string	請求 ID。	E897D16A-50EB-543F-B002-C5A26AB818FF
IpamScopeId	string	IPAM 作用範圍的執行個體 ID。	ipam-scope-glfmcyldpm8lsy****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E897D16A-50EB-543F-B002-C5A26AB818FF",
  "IpamScopeId": "ipam-scope-glfmcyldpm8lsy****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	ResourceNotFound.Ipam	The specified resource of ipam is not found.	輸入的IPAM不存在。
400	UnsupportedFeature.PublicIpamScopeType	The feature of PublicIpamScopeType is not supported.	您指定的IPAM暫不支援建立Public類型的作用範圍。
400	QuotaExceeded.IpamScopeQuotaPerIpam	The quota of ipamScopeQuotaPerIpam count is exceeded.	IPAM作用範圍允許的最大數量超過限制。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun校正通過。

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

變更歷史

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