VPN網關續訂
更新時間 2023-12-28 15:00:11
最近更新時間: 2023-12-28 15:00:11
分享文章
支持VPN網關包周期計費的續訂。
接口功能介紹
支持VPN網關包周期計費的續訂
接口約束
支持主備模式資源池，并且用戶VPN網關非按需訂單，用戶配額未滿；用戶賬戶余額充足，該接口無法使用優惠券支付，若余額不足會創建一個待支付訂單。
URI
POST /v4/vpn/gateway/renew
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客戶端存根，用于保證訂單冪等性。要求單個云平臺賬戶內唯一。 | ||
| regionID | 是 | String | 資源池ID, 例:100054c0416811e9a6690242ac110002 | ||
| userVPNResourceID | 是 | String | VPN網關資源ID | ||
| cycleType | 否 | String | 包周期類型，YEAR/MONTH | ||
| cycleCount | 否 | Integer | 包周期數，周期最大長度不能超過36個月 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| 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重試下單，查詢訂單是否成功
{
"clientToken": "uniqureAnyString",
"regionID": "81f7728662dd11ec810800155d307d5b",
"cycleType": "MONTH",
"cycleCount": 1,
"userVPNResourceID": "6f887fa6d89f4617a5a21c7955a15e22"
}
響應示例
{
"returnObj": {
"masterOrderNO": "",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "abe476445e4411edb4f40242ac110003"
},
"details": "",
"message": "success",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求未成功(可能暫時未成功，首次下單后會是訂單處理中,狀態碼為900) |
錯誤碼
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 請求參數無效 |
| OPENAPI.VPN.AccessFailed | 內部錯誤，請重試。如果多次嘗試失敗，請提交工單 |
