文档

DeleteNatIp - 删除NAT IP地址

更新时间:

调用DeleteNatIp接口删除NAT IP地址。

接口说明

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

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

  • 当查询不到该 NAT IP 地址时,表示 NAT IP 地址已删除。

调试

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

授权信息

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

请求参数

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

要删除的 NAT IP 地址所属 NAT 网关实例的地域 ID。

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

cn-qingdao
NatIpIdstring

要删除的 NAT IP 地址实例 ID。

vpcnatip-gw8y7q3cpk3fggs87****
DryRunboolean

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

  • true:发送检查请求,不会删除 NAT IP 地址。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 2xx HTTP 状态码并删除 NAT IP 地址。

false
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
5A2CFF0E-5718-45B5-9D4D-70B3FF3898

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

E9AD97A0-5338-43F8-8A80-5E274CCBA11B

示例

正常返回示例

JSON格式

{
  "RequestId": "E9AD97A0-5338-43F8-8A80-5E274CCBA11B"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectStatus.NatIpThe status of %s [%s] is incorrect.NatIp当前状态不正确。
400OperationFailed.DefaultNatIpThe operation is failed because of default NatIP can not be deleted.操作失败,因为无法删除默认的NatIP。
400DependencyViolation.NatIpThe specified resource of %s depends on %s, so the operation cannot be completed.有依赖的NAT IP,所以此操作不能进行
400IncorrectStatus.NatGatewayThe status of %s [%s] is incorrect.-
400IncorrectStatus.NatGateway%The status of %s [%s] is incorrect.nat网关状态不正确
400DependencyViolation.FullNatEntryThe fullnat entry depends on this nat ip,so the operation cannot be completed.存在Fullnat配置条目依赖此nat ip,因此本操作不能完成。
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。
404ResourceNotFound.NatIpThe specified resource of %s is not found.NatIp资源找不到。
404ResourceNotFound.NatGatewayThe specified resource of %s is not found.-
404ResourceNotFound.NatIpCidrThe specified resource of %s is not found.找不到指定的%s资源。

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

变更历史

变更时间变更内容概要操作
2024-01-18OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
2023-03-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
  • 本页导读 (1)