调用DeleteVpnRouteEntry接口删除VPN目的路由。
接口说明
- DeleteVpnRouteEntry 接口属于异步接口,即系统先返回一个请求 ID,但该 VPN 目的路由尚未删除成功,系统后台的删除任务仍在进行。您可以调用 DescribeVpnGateway 查询 VPN 网关实例状态,来确定 VPN 目的路由的删除状态:
- 当 VPN 网关实例处于 updating 状态时,表示 VPN 目的路由正在删除中。
- 当 VPN 网关实例处于 active 状态时,表示 VPN 目的路由删除成功。
- DeleteVpnRouteEntry 接口不支持在同一 VPN 网关下并发删除 VPN 目的路由。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:DeleteVpnRouteEntry |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | VPN 网关实例所属地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| d7d24a21-f4ba-4454-9173-b3828dae492b |
VpnGatewayId | string | 是 | VPN 网关的 ID。 | vpn-bp1a3kqjiiq9legfx**** |
RouteDest | string | 是 | 目的路由的目标网段。 | 10.0.0.0/24 |
NextHop | string | 是 | 目的路由的下一跳。 | vco-bp15oes1py4i66rmd**** |
Weight | integer | 是 | 目的路由的权重值,取值:
| 0 |
OverlayMode | string | 否 | 隧道协议,取值:Ipsec(IPsec 隧道协议)。 | Ipsec |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE\t"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Resource.QuotaFull | The quota of resource is full | 资源配额已达上限。 |
400 | VpnGateway.Configuring | The specified service is configuring. | 服务正在配置中,请您稍后再试。 |
400 | VpnGateway.FinancialLocked | The specified service is financial locked. | 该服务已欠费,请您先充值再操作。 |
400 | VpnRouteEntry.AlreadyExists | The specified route entry is already exist. | 该路由已存在。 |
400 | VpnRouteEntry.Conflict | The specified route entry has conflict. | 路由条目存在冲突。 |
400 | VpnRouteEntry.Configuring | The specified route entry is configuring. | 指定的路由条目正在配置中。 |
400 | InvalidRouteEntry.NotFound | The specified route entry does not exist. | 指定的路由条目不存在。 |
400 | VpnTask.CONFLICT | Vpn task has conflict. | Vpn操作存在冲突,请稍后重试。 |
400 | TaskConflict | The operation is too frequent, please wait a moment and try again. | 操作过于频繁,请稍等一会再重试 |
403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | 您没有权限操作该资源,请您申请操作权限后再试。 |
403 | Forbidden | User not authorized to operate on the specified resource. | 您没有权限操作指定资源,请申请权限后再操作。 |
404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | 指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。 |
访问错误中心查看更多错误码。