DeleteIpam - 删除一个IPAM实例

删除IPAM实例。

接口说明

前提条件

  • 删除 IPAM 前,请确保该 IPAM 下的地址池已全部删除。您可以通过调用 DeleteIpamPool 接口删除地址池。
  • 删除 IPAM 前,请确保该 IPAM 下新创建的 IPAM 地址空间已全部删除。您可以通过调用 DeleteIpamScope 接口删除 IPAM 地址空间。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DeleteIpamcreate
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
IpamIdstring

IPAM 的实例 ID。

ipam-ccxbnsbhew0d6t****
DryRunboolean

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

  • true:发送检查请求,不会删除 IPAM。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码 DryRunOperation。
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接删除 IPAM。
false
ClientTokenstring

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000

返回参数

名称类型描述示例值
object

返回的信息列表。

RequestIdstring

请求 ID。

30A20EE2-6223-5D0F-BF49-D7C78F206063

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400ResourceNotFound.IpamThe specified resource of ipam is not found.输入的IPAM不存在。
400OperationFailed.IpamScopeExistThe operation is failed because user IPAM scope exist.操作失败,原因是存在用户自定义scope。
400OperationFailed.IpamPoolExistThe operation is failed because user IPAM pool exist.操作失败,原因是IPAM存在用户创建地址池。
400DryRunOperationRequest validation has been passed with DryRun flag set.DryRun校验通过。

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

变更历史

变更时间变更内容概要操作
暂无变更历史