全部產品
Search
文件中心

:DeleteIpam - 刪除一個IPAM執行個體

更新時間:Oct 10, 2025

刪除IPAM執行個體。

介面說明

前提條件

  • 刪除 IPAM 前,請確保該 IPAM 下的位址集區已全部刪除。您可以通過調用 DeleteIpamPool 介面刪除位址集區。

  • 刪除 IPAM 前,請確保該 IPAM 下新建立的 IPAM 作用範圍已全部刪除。您可以通過調用 DeleteIpamScope 介面刪除 IPAM 作用範圍。

  • 刪除 IPAM 前,請確保該 IPAM 下的預設資摘要搜索執行個體不存在共用關係。

  • 刪除 IPAM 前,請確保沒有共用的資摘要搜索執行個體關聯到該 IPAM 執行個體。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DeleteIpam

create

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

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

cn-hangzhou

IpamId

string

IPAM 的執行個體 ID。

ipam-ccxbnsbhew0d6t****

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

返回參數

名稱

類型

描述

樣本值

object

返回的資訊列表。

RequestId

string

請求 ID。

30A20EE2-6223-5D0F-BF49-D7C78F206063

樣本

正常返回樣本

JSON格式

{
  "RequestId": "30A20EE2-6223-5D0F-BF49-D7C78F206063"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 ResourceNotFound.Ipam The specified resource of ipam is not found. 輸入的IPAM不存在。
400 OperationFailed.IpamScopeExist The operation is failed because user IPAM scope exist. 操作失敗,原因是存在使用者自訂scope。
400 OperationFailed.IpamPoolExist The operation is failed because user IPAM pool exist. 操作失敗,原因是IPAM存在使用者建立位址集區。
400 DryRunOperation Request validation has been passed with DryRun flag set. DryRun校正通過。
400 OperationDenied.SharedResourceDiscoveryAssociated The operation is not allowed because the IPAM is associated with a shared resource discovery. 無法刪除IPAM,原因是該IPAM關聯了共用的資摘要搜索。
400 DependencyViolation.ShareResource The operation is not allowed because the default resource discovery of this IPAM is sharing. 無法刪除IPAM,原因是該IPAM的預設資摘要搜索存在共用關係。

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

變更歷史

更多資訊,參考變更詳情