DeleteIpamPool - 删除IPAM地址池实例

更新时间:
复制 MD 格式

删除IPAM地址池实例。

接口说明

使用说明

  • 删除父地址池前,请确保父地址池下的子地址池已全部被删除。

  • 当父地址池设置了生效地域,且该父地址池有已经分配出去的地址时,该父地址池不允许被删除。

  • 当子地址池设置了生效地域,且该地址池有已经分配出去的地址时,该子地址池不允许被删除。

  • 当地址池存在共享关系时,该地址池不允许被删除。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

RegionId

string

IPAM 托管地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

IpamPoolId

string

IPAM 地址池的实例 ID。

ipam-pool-6rcq3tobayc20t****

DryRun

boolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会删除 IPAM 地址池实例。检查项包括是否填写了必需参数、请求格式、实例状态。如果检查不通过,则返回对应错误。如果检查通过,则返回 DryRunOperation。

  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。

false

ClientToken

string

客户端 Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明

若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。

123e4567-e89b-12d3-a456-426655440000

返回参数

名称

类型

描述

示例值

object

返回的信息列表。

RequestId

string

请求 ID。

57B7DCCA-F192-5528-8AF3-2FE1413228C9

示例

正常返回示例

JSON格式

{
  "RequestId": "57B7DCCA-F192-5528-8AF3-2FE1413228C9"
}

错误码

HTTP status code

错误码

错误信息

描述

400 OperationDenied.PoolRegionNotSupportDeletePool The operation is not allowed because of pool region not support delete. 操作被拒绝,原因是无法在该地域执行删除地址池操作。
400 DependencyViolation.SubCidr The specified resource of %s depends on %s, so the operation cannot be completed. 指定的资源被其他的资源依赖,不允许进行当前操作。
400 DependencyViolation.CustomCidrs The specified resource of %s depends on %s, so the operation cannot be completed. 指定的资源被其他的资源依赖,不允许进行当前操作。
400 Forbidden.SubPool The IPAM pool contains subpools. IPAM地址池中含有子池,不允许删除。
400 DryRunOperation Request validation has been passed with DryRun flag set. DryRun校验通过。
400 OperationDenied.OperateShareResource The operation is not allowed because the instance is a shared resource. 该实例是共享资源,不允许操作。
400 IncorrectStatus.IpamPool The status of the IPAM pool is incorrect. IPAM地址池的状态不正确。
400 DependencyViolation.ShareResource The specified resource of IPAM pool depends on resource sharing, so the operation cannot be completed. IPAM地址池存在共享关系,无法完成当前操作。
400 DependencyViolation.PoolCidr The operation is not allowed because the IpamPool has pool CIDR dependency %s. 操作被拒绝,地址池存在预置CIDR依赖%s。
400 OperationDenied.IpamPoolAllocationExist The operation is not allowed because the IpamPool has existing allocations. 操作被拒绝,地址池下存在分配记录。
400 DependencyViolation.CustomPoolAllocation The operation is not allowed because the IpamPool has custom pool allocation dependency. 操作被拒绝,地址池存在自定义分配依赖。
404 ResourceNotFound.IpamPool The dependent IPAM pool is not found. 依赖资源IPAM Pool不存在。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情