CreateIpamPool

更新時間:
Copy as MD

建立 IPAM 位址池。

介面說明

  • 每個地域每種 ISP 類型的公網 IPv6 頂級池的數量預設最多為 1 個。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

IPAM 託管地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。

cn-hangzhou

IpamScopeId

string

IPAM 作用範圍的執行個體 ID。

ipam-scope-glfmcyldpm8lsy****

IpamPoolName

string

IPAM 位址池的名稱。

長度為 1~128 個字元,不能以 http://https:// 開頭。

abc

IpamPoolDescription

string

IPAM 位址池的描述。

長度為 1~256 個字元,必須以大小寫英文字母或者中文字元開頭,但不能以 http://https:// 開頭。不填則為空,預設值為空。

test description

ResourceGroupId

string

IPAM 位址池的資源群組 ID。

rg-acfmxazb4ph6aiy****

PoolRegionId

string

IPAM 位址池生效地域。

cn-hangzhou

SourceIpamPoolId

string

來源 IPAM 位址池的執行個體 ID。

說明

不輸入此參數時,表示建立的位址池為父位址池。

ipam-pool-6rcq3tobayc20t****

AllocationDefaultCidrMask

integer

IPAM 位址池分配的預設網路遮罩。

說明

IPv4 網路遮罩取值範圍為 0~32 位元,IPv6 網路遮罩取值範圍為 0~128 位元。

28

AllocationMaxCidrMask

integer

IPAM 位址池分配的最大網路遮罩。

說明

IPv4 網路遮罩取值範圍為 0~32 位元,IPv6 網路遮罩取值範圍為 0~128 位元。

32

AllocationMinCidrMask

integer

IPAM 位址池分配的最小網路遮罩。

說明

IPv4 網路遮罩取值範圍為 0~32 位元,IPv6 網路遮罩取值範圍為 0~128 位元。

8

DryRun

boolean

是否只預檢此次請求。取值:

  • true:傳送檢查請求,不會建立 IPAM 位址池。檢查項包括是否填寫了必需參數、請求格式、執行個體狀態。如果檢查不通過,則傳回對應錯誤。如果檢查通過,則傳回 DryRunOperation。

  • false(預設值):傳送正常請求,通過檢查後傳回 HTTP 2xx 狀態碼並直接進行操作。

false

ClientToken

string

用戶端 Token,用於保證請求的冪等性。從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

說明

若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。

123e4567-e89b-12d3-a456-426655440000

IpVersion

string

IP 位址協定版本。取值:

  • IPv4:IPv4 協定。

  • IPv6:IPv6 協定。

IPv4

Ipv6Isp

string

IPv6 位址段類型,僅對公網 IPv6 位址池生效。取值:

  • BGP(預設值):阿里雲 BGP IPv6。

  • ChinaMobile:中國移動(單線)。

  • ChinaUnicom:中國聯通(單線)。

  • ChinaTelecom:中國電信(單線)。

說明

如果是開通了單線頻寬白名單的使用者,該欄位可以設定為 ChinaTelecom(中國電信)、ChinaUnicom(中國聯通)或 ChinaMobile(中國移動)。

BGP

AutoImport

boolean

位址池是否開啟自動匯入功能。

true

Tag

array<object>

標籤列表資訊。

object

標籤列表資訊。

Key

string

資源的標籤索引鍵。最多支援 20 個標籤索引鍵。一旦傳入該值,則不允許為空字串。

最多支援 64 個字元,必須以字母或中文開頭,可包含數字、半形句號(.)、底線(_)和短劃線(-),不能以 aliyunacs: 開頭,不能包含 http:// 或者 https://

說明

參數 ResourceId.NTag.NTag.N.KeyTag.N.Value)至少輸入一個。

FinanceDept

Value

string

資源的標籤值。最多支援 20 個標籤值。一旦傳入該值,可以為空字串。

最多支援 128 個字元,不能包含 http:// 或者 https://

說明

參數 ResourceId.NTag.NTag.N.KeyTag.N.Value)至少輸入一個。

FinanceJoshua

返回參數

名稱

類型

描述

樣本值

object

傳回的資訊列表。

RequestId

string

請求 ID。

BB2C39DE-CEB8-595A-981A-F2EFCBE7324E

IpamPoolId

string

IPAM 位址池的執行個體 ID。

ipam-pool-6rcq3tobayc20t****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "BB2C39DE-CEB8-595A-981A-F2EFCBE7324E",
  "IpamPoolId": "ipam-pool-6rcq3tobayc20t****"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 ResourceNotFound.IpamScope The specified resource of IPAM scope is not found.
400 ResourceNotFound.SourceIpamPool The dependent source IPAM pool is not found.
400 UnsupportedFeature.PublicIpamScopeType The feature of PublicIpamScopeType is not supported.
400 IllegalParam.AllocationDefaultNetmask The specified AllocationDefaultNetmask is illegal.
400 IllegalParam.AllocationMaxNetmask The specified AllocationMaxNetmask is illegal.
400 IllegalParam.AllocationMinNetmask The specified AllocationMinNetmask is illegal.
400 IllegalParam.IpVersion The specified IpVersion is illegal.
400 QuotaExceeded.IpamPoolQuotaDepth The quota of IpamPoolQuotaDepth count is exceeded.
400 ResourceNotFound.Ipam The specified resource of ipam is not found.
400 IllegalParam.PoolRegionId The specified PoolRegionId is illegal.
400 QuotaExceeded.IpamSubPoolQuotaPerIpamPool The quota of ipamSubPoolQuotaPerIpamPool count is exceeded.
400 DryRunOperation Request validation has been passed with DryRun flag set.
400 IncorrectStatus.IpamPool The status of the IPAM pool is incorrect.
400 OperationDenied.OperateShareResource The operation is not allowed because the instance is a shared resource.
400 UnsupportedFeature.IpamPublicIpv4Pool The feature of public IPv4 pool is not supported in IPAM.
400 OperationDenied.IpamPublicIpv6PoolNeedPoolRegion The public IPv6 pool cannot be created in IPAM when its pool region is empty.
400 IllegalParam.Ipv6Isp The specified Ipv6Isp is illegal.
400 UnsupportedFeature.Ipv6Isp The Ipv6Isp feature is not supported.
400 UnsupportedRegion.Ipv6Isp The current region does not support this feature.
400 QuotaExceeded.IpamPublicIpv6TopPoolQuotaPerRegionIsp The number of public IPv6 top pool in IPAM for this ISP owned by the user in this region exceeds the limit.
400 Mismatch.IpamScopeAndSourceIpamPool The input source IPAM pool is not in the input IPAM scope.
400 Mismatch.Ipv6IspAndSourceIpamPool The input Ipv6Isp is inconsistent with the Ipv6Isp of the input source IPAM pool.
400 UnsupportedFeature.IpamIpv6 The feature of IPv6 is not supported in this region.
400 Mismatch.ChildIpVersionAndParentIpVersion The ChildIpVersion and ParentIpVersion are mismatched.
400 Mismatch.ChildPoolRegionAndParentPoolRegion The ChildPoolRegion and ParentPoolRegion are mismatched.
400 Mismatch.ChildIpamScopeAndParentIpamScope The ChildIpamScope and ParentIpamScope are mismatched.
400 Mismatch.ChildIpv6IspAndParentIpv6Isp The ChildIpv6Isp and ParentIpv6Isp are mismatched.

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

變更歷史

更多資訊,參考變更詳情