VPN網關訂購
更新時間 2023-12-28 15:00:10
最近更新時間: 2023-12-28 15:00:10
分享文章
支持按需/包年包月訂購VPN網關。
接口功能介紹
支持按需/包年包月訂購VPN網關。
接口約束
支持主備模式資源池,并且用戶VPN網關配額未滿;用戶賬戶余額充足,該接口無法使用優惠券支付,若余額不足會創建一個待支付訂單。
URI
POST /v4/vpn/gateway/new
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客戶端存根,用于保證訂單冪等性。要求單個云平臺賬戶內唯一。 | ||
| regionID | 是 | String | 資源池ID, 例:100054c0416811e9a6690242ac110002 | ||
| vpnGatewayName | 是 | String | VPN網關名字 | ||
| vpcId | 是 | String | VPC ID | ||
| bandwidth | 是 | Integer | 帶寬,單位為Mbps | ||
| connectionLimit | 是 | Integer | VPN網關連接數限制 | ||
| onDemand | 否 | Boolean | 是否按需下單,默認為false | ||
| cycleType | 否 | String | 本參數表示包周期類型。 取值范圍: YEAR MONTH onDemand為false時,必須指定。 |
||
| cycleCount | 否 | Integer | 包周期數。onDemand為false時必須指定。周期最大長度不能超過36個月 | ||
| description | 否 | String | 描述 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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 | 訂單號 | ||
| masterResourceID | String | 主資源ID | ||
| masterResourceStatus | String | 主資源狀態,只有主訂單資源會返回 | ||
| regionID | String | 資源所屬資源池ID | ||
| resources | Array of Object | 資源明細列表,參考表Resource | Resource |
表 Resource
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| resourceID | String | 單項資源的變配、續訂、退訂等需要該資源項的ID,比如某個云主機資源作為主資源,對其掛載 | |||
| orderID | String | 無需關心 | |||
| startTime | Integer | 啟動時刻,epoch時戳,毫秒精度 | |||
| expireTime | Integer | 過期時刻,epoch時戳,毫秒精度 | |||
| createTime | Integer | 創建時刻,epoch時戳,毫秒精度 | |||
| updateTime | Integer | 更新時刻,epoch時戳,毫秒精度 | |||
| status | Integer | 資源狀態,無需關心。參考masterResourceStatus | |||
| isMaster | Boolean | 是否是主資源項 | |||
| itemValue | Integer | 資源規格,VPN網關帶寬大小或VPN連接數 | |||
| resourceUUID | String | 資源UUID,結合regionID一起使用 | |||
| resourceConfig | Object | VPN網關資源配置或VPN連接資源配置 |
請求示例
請求頭header
無
請求體body
可使用同clientToken重試下單,查詢訂單是否成功
{
"clientToken": "",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"vpnGatewayName": "vpn-gateway04",
"vpcId": "vpc-0ze19rj2",
"bandwidth": 5,
"connectionLimit": 10,
"onDemand": false,
"cycleType": "month",
"cycleCount": 2,
"description": ""
}
響應示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "cc4d89345cf011edabf50242ac110003",
"masterResourceID": "6f887fa6d89f4617a5a21c7955a15e22",
"masterOrderNO": null,
"resources": [{
"orderID": "dcdae4ffdeb740ca8ab8ed000bad7e62",
"status": 2,
"isMaster": true,
"resourceType": "VPN_GETWAY",
"resourceID": "6f887fa6d89f4617a5a21c7955a15e22",
"masterOrderID": "cc4d89345cf011edabf50242ac110003",
"updateTime": 1667642516000,
"masterResourceID": "6f887fa6d89f4617a5a21c7955a15e22",
"itemValue": 5,
"startTime": 1667642500000,
"resourceConfig": {
"projectID": "0",
"number": "5",
"zoneid": "81f7728662dd11ec810800155d307d5b",
"bandwidth": "5",
"vpnname": "vpn-gateway04-openapineworder",
"size": "5",
"isauto": "1",
"regionid": "81f7728662dd11ec810800155d307d5b",
"ifautorenew": "false",
"version": "v1",
"zonetype": "1",
"type": "1",
"spec": "standard",
"yptProductLimit": "PUB_100_02_0001",
"autorenewcyclecnt": "0",
"prodissupportedcredit": "PUB_100_02_0001",
"desc": "new order test for openapi",
"vpcid": "vpc-fbv8opnarp",
"platformid": "81f7728662dd11ec810800155d307d5b",
"value": "5",
"billmode": "1"
},
"createTime": 1667642483000
}, {
"orderID": "dcdae4ffdeb740ca8ab8ed000bad7e62",
"status": 2,
"isMaster": false,
"resourceType": "VPN_LINK",
"resourceID": "a9c27f76ad7a4a6888e1e51848de652c",
"masterOrderID": "cc4d89345cf011edabf50242ac110003",
"updateTime": 1667642516000,
"masterResourceID": "6f887fa6d89f4617a5a21c7955a15e22",
"itemValue": 1,
"startTime": 1667642500000,
"resourceConfig": {
"yptProductLimit": "PUB_100_02_0001",
"number": "1",
"platformid": "81f7728662dd11ec810800155d307d5b",
"projectID": "0",
"regionid": "81f7728662dd11ec810800155d307d5b",
"prodissupportedcredit": "PUB_100_02_0001",
"value": "1",
"zoneid": "81f7728662dd11ec810800155d307d5b",
"version": "v1",
"billmode": "1",
"zonetype": "1",
"spec": "10",
"size": "1"
},
"createTime": 1667642483000
}]
},
"details": "",
"message": "success",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求未成功(可能暫時未成功,首次下單后會是訂單處理中,狀態碼為900) |
錯誤碼
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 請求參數無效 |
| OPENAPI.VPN.AccessFailed | 內部錯誤,請重試。如果多次嘗試失敗,請提交工單 |