VPN網關退訂
更新時間 2023-12-28 15:00:12
最近更新時間: 2023-12-28 15:00:12
分享文章
支持退訂一個包周期計費/按需的VPN網關。退訂后，將退還對應部分VPN網關費用。
接口功能介紹
支持退訂一個包周期計費/按需的VPN網關。退訂后，將退還對應部分VPN網關費用。
接口約束
支持集群模式資源池，并且當前VPN網關沒有綁定用戶網關和VPN連接。
URI
POST /v4/vpn/vpn-gateway/refund
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客戶端存根，用于保證訂單冪等性。要求單個云平臺賬戶內唯一。 | new1order2test3for4vpn110701 | |
| regionID | 是 | String | 資源池ID, 例:81f7728662dd11ec810800155d307d5b | 81f7728662dd11ec810800155d307d5b | |
| resourceID | 是 | String | VPN網關資源ID | 6f887fa6d89f4617a5a21c7955a15e22 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| 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, 例:100054c0416811e9a6690242ac110002 |
請求示例
請求url
無
請求頭header
無
請求體body
{
"clientToken": "new1order2test3for4vpn110701",
"regionID": "81f7728662dd11ec810800155d307d5b",
"resourceID": "6f887fa6d89f4617a5a21c7955a15e22"
}
響應示例
{
"returnObj":{
"masterOrderNO":"20230616191010514873",
"regionID":"b342b77ef26b11ecb0ac0242ac110002",
"masterOrderID":"b799f99065ce4f55b05930c176806d22"
},
"details":"",
"message":"success",
"description":"成功",
"statusCode":800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 表示請求未成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
