全部产品
Search
文档中心

弹性公网 IP:DeletePublicIpAddressPool - 删除IP地址池

更新时间:May 31, 2024

调用DeletePublicIpAddressPool接口删除IP地址池。

接口说明

在调用本接口时,请了解以下内容:

  • 删除 IP 地址池前,请确保该地址池内的 IP 地址没有被使用。

  • DeletePublicIpAddressPool 接口属于异步接口,即系统会先返回一个请求 ID,但 IP 地址池并未删除完成,系统后台的删除任务仍在进行。您可以调用 ListPublicIpAddressPools 查询 IP 地址池的状态。

    • 当 IP 地址池处于 Deleting 状态时,表示 IP 地址池正在删除中,在该状态下,您只能执行查询操作,不能执行其他操作。

    • 当查询不到该 IP 地址池时,表示 IP 地址池删除完成。

  • DeletePublicIpAddressPool 接口不支持并发删除同一个 IP 地址池。

调试

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

授权信息

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

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

请求参数

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

IP 地址池的实例 ID。

pippool-6wetvn6fumkgycssx****
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

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

0c593ea1-3bea-11e9-b96b-88e9fe60000
DryRunboolean

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

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

要创建的 IP 地址池所在的地域 ID。

cn-chengdu

返回参数

名称类型描述示例值
object

返回数据结构体。

RequestIdstring

请求 ID。

4EC47282-1B74-4534-BD0E-403F3EE64CAF

示例

正常返回示例

JSON格式

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

错误码

HTTP status code错误码错误信息描述
400ResourceNotFound.PublicIpAddressPoolThe specified resource ofPublicIpAddressPool [%s] is not found.-
400IncorrectStatus.PublicIpAddressPoolThe status of PublicIpAddressPool [%s] is incorrect.-
400ResourceInUse.PublicIpAddressPoolThe specified resource of PublicIpAddressPool [%s] is in use.-
400OperationFailed.ResourceIsSharedThe operation is failed because of PublicIpAddressPool is shared with other users.公网IP地址池已经共享给其他用户,不允许删除。
400OperationDenied.OperateSharedResourceThe operation is not allowed because of the PublicIpAddressPool is a shared resource.该公网IP地址池实例是共享资源,不允许修改。

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

变更历史

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