文档

DeleteIpv4Gateway - 删除IPv4网关

更新时间:

调用DeleteIpv4Gateway接口删除IPv4网关。

接口说明

  • 删除 IPv4 网关实例前,请确保已解绑 IPv4 网关实例关联的路由表。

  • DeleteIpv4Gateway 接口属于异步接口,即系统会先返回一个 RequestId,但该 IPv4 网关实例并未删除完成,系统后台的删除任务仍在进行。您可以调用 GetIpv4GatewayAttribute 查询 IPv4 网关实例的状态。

    • 当 IPv4 网关实例处于 Deleting 状态时,表示正在删除中。

    • 当 IPv4 网关实例无法被查询到时,表示删除完成。

  • DeleteIpv4Gateway 接口不支持并发删除同一个 IPv4 网关实例。

调试

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

授权信息

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

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

请求参数

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

要删除的 IPv4 网关的实例 ID。

ipv4gw-5tsnc6s4ogsedtp3k****
RegionIdstring

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

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

ap-southeast-6
ClientTokenstring

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

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

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

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

21133AC0-0636-521B-A400-253818691A56

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400ResourceNotFound.Ipv4GatewayThe specified resource ipv4Gateway is not found.未找到指定的Ipv4网关,无法删除
400IncorrectStatus.Ipv4GatewayThe status of %s [%s] is incorrect.指定的Ipv4Gateway处于非稳态,请稍后重试
400OperationDenied.RouteEntryExistThe operation is not allowed because of existing routeEntry point to ipv4Gateway.无法删除Ipv4网关,因为存在到Ipv4网关的路由
400OperationDenied.GatewayAlreadyAssociatedThe operation is not allowed because of the specified resource %s is already associated.操作不允许,因为指定的Ipv4网关处于绑定状态
400OperationFailed.Ipv4GatewayUsedByEipBindIpAddressFailed 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网关。

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

变更历史

变更时间变更内容概要操作
2023-08-07OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-04-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈