调用DeleteIpv4Gateway接口删除IPv4网关。

使用说明

  • 删除IPv4网关实例前，请确保已解绑IPv4网关实例关联的路由表。
  • DeleteIpv4Gateway接口属于异步接口，即系统会先返回一个RequestId，但该IPv4网关实例并未删除完成，系统后台的删除任务仍在进行。您可以调用GetIpv4GatewayAttribute查询IPv4网关实例的状态。
    • 当IPv4网关实例处于Deleting状态时，表示正在删除中。
    • 当IPv4网关实例无法被查询到时，表示删除完成。
  • DeleteIpv4Gateway接口不支持并发删除同一个IPv4网关实例。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DeleteIpv4Gateway

系统规定参数。取值：DeleteIpv4Gateway。
Ipv4GatewayId String 是 ipv4gw-5tsnc6s4ogsedtp3k****

要删除的IPv4网关的实例ID。
RegionId String 是 ap-southeast-6

要删除的IPv4网关所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。
ClientToken String 否 123e4567-e89b-12d3-a456-426655440000

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

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

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
DryRun Boolean 否 false

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

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

返回数据

名称 类型 示例值 描述
RequestId String 21133AC0-0636-521B-A400-253818691A56

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DeleteIpv4Gateway
&Ipv4GatewayId=ipv4gw-5tsnc6s4ogsedtp3k****
&RegionId=ap-southeast-6
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&DryRun=false
&公共请求参数

正常返回示例

XML格式

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

<DeleteIpv4GatewayResponse>
    <RequestId>21133AC0-0636-521B-A400-253818691A56</RequestId>
</DeleteIpv4GatewayResponse>

JSON格式

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

{
  "RequestId" : "21133AC0-0636-521B-A400-253818691A56"
}

错误码

HttpCode 错误码 错误信息 描述
400 ResourceNotFound.Ipv4Gateway The specified resource ipv4Gateway is not found. 未找到指定的Ipv4网关，无法删除
400 OperationDenied.RouteEntryExist The operation is not allowed because of existing routeEntry point to ipv4Gateway. 无法删除Ipv4网关，因为存在到Ipv4网关的路由
400 OperationDenied.GatewayAlreadyAssociated The operation is not allowed because of the specified resource %s is already associated. 操作不允许，因为指定的Ipv4网关处于绑定状态
400 OperationFailed.Ipv4GatewayUsedByEipBindIpAddress Failed to delete the IPv4 gateway because the EIP associated with a private IP address requires the IPv4 gateway to implement outbound Internet access. 存在Eip绑定私网IP出公网的场景，此功能的实现依赖IPv4网关的存在，故无法删除IPv4网关。

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