接口功能介绍
支持退订一个包周期计费/按需的VPN网关。退订后，将退还对应部分VPN网关费用。
接口约束
支持主备模式资源池，并且当前VPN网关没有绑定用户网关和VPN连接。
URI
POST /v4/vpn/gateway/refund
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。 | ||
| regionID | 是 | String | 资源池ID, 例:100054c0416811e9a6690242ac110002 | ||
| resourceID | 是 | String | VPN网关资源ID |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | |||
| message | String | 失败时的错误描述，一般为英文描述 | |||
| description | String | 失败时的错误描述，一般为中文描述 | |||
| returnObj | Object | 返回对象 | returnObj | ||
| errorCode | String | 业务细分码，为product.module.code三段式码 | |||
| details | Object | 错误明细，一般情况下，会对订单侧(bss)的VPN网关订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterOrderID | String | 订单ID，调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态。 | |||
| masterOrderNO | String | 订单号 | |||
| regionID | String | 资源池ID |
请求示例
请求头header
无
请求体body
{
"clientToken": "new1order2test3for4vpn110701",
"regionID": "81f7728662dd11ec810800155d307d5b",
"resourceID": "6f887fa6d89f4617a5a21c7955a15e22"
}
响应示例
{
"returnObj": {
"masterOrderNO": "",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "abe476445e4411edb4f40242ac110003"
},
"details": "",
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功(可能暂时未成功，首次下单后会是订单处理中,状态码为900) |
错误码
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 请求参数无效 |
| OPENAPI.VPN.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
