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

使用说明

  • DeleteNatIp接口属于异步接口,即系统会先返回一个请求ID,但该NAT IP地址并未删除完成,系统后台的删除任务仍在进行。您可以调用DescribeNatGateways查询NAT IP地址的删除状态:
    • 当NAT IP地址处于Deleting状态时,表示NAT IP地址正在删除中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当查询不到该NAT IP地址时,表示NAT IP地址已删除。
  • DeleteNatIp接口不支持并发删除同一个NAT IP地址。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-qingdao

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

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

NatIpId String vpcnatip-gw8y7q3cpk3fggs87****

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

DryRun Boolean false

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

  • true:发送检查请求,不会删除NAT IP地址。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回2xx HTTP状态码并删除NAT IP地址。
ClientToken String 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

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

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

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

系统规定参数。取值:DeleteNatIp

返回数据

名称 类型 示例值 描述
RequestId String E9AD97A0-5338-43F8-8A80-5E274CCBA11B

请求ID。

示例

请求示例

http(s)://[Endpoint]/?RegionId=cn-qingdao
&NatIpId=vpcnatip-gw8y7q3cpk3fggs87****
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&Action=DeleteNatIp
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteNatIpResponse>
    <RequestId>E9AD97A0-5338-43F8-8A80-5E274CCBA11B</RequestId>
</DeleteNatIpResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 IncorrectStatus.NatIp The status of %s [%s] is incorrect. NatIp当前状态不正确。
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. 指定的RegionId不存在。
404 ResourceNotFound.NatIp The specified resource of %s is not found. NatIp资源找不到。

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