文档

DeleteIpsecServer - 删除IPsec服务端

更新时间:

调用DeleteIpsecServer接口删除IPsec服务端。

接口说明

  • DeleteIpsecServer 接口属于异步接口,即系统先返回一个请求 ID,但该 IPsec 服务端尚未删除成功,系统后台的删除任务仍在进行。您可以调用 DescribeVpnGateway 查询 VPN 网关实例状态,来确定 IPsec 服务端的删除状态:
    • 当 VPN 网关实例处于 updating 状态时,表示 IPsec 服务端正在删除中。
    • 当 VPN 网关实例处于 active 状态时,表示 IPsec 服务端删除成功。
  • DeleteIpsecServer 接口不支持在同一 VPN 网关下并发删除 IPsec 服务端。

调试

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

授权信息

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

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

请求参数

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

IPsec 服务端所属地域 ID。

cn-hangzhou
IpsecServerIdstring

IPsec 服务端 ID。

iss-bp1jougp8cfsbo8y9****
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4-130e-11e9-8e44-00****
DryRunstring

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

  • true:只预检此次请求,不会删除 IPsec 服务端。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误信息。如果检查通过,则返回DryRunOperation

  • false(默认值):发送正常请求,通过检查后直接删除 IPsec 服务端。

false

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

0ED8D006-F706-4D23-88ED-E11ED28DCAC0

示例

正常返回示例

JSON格式

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

错误码

HTTP status code错误码错误信息描述
400VpnGateway.ConfiguringThe specified service is configuring.服务正在配置中,请您稍后再试。
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。
404InvalidIpsecServerId.NotFoundThe specified IPsec server ID (%s) does not exist.-
409OperationConflictThe operation against this instance is too frequent, please try again later.对该实例的操作过于频繁,请稍后重试。

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

变更历史

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