VPN網關訂購
更新時間 2025-04-03 11:14:45
最近更新時間: 2025-04-03 11:14:45
分享文章
多AZ資源池VPN網關訂購。
接口功能介紹
多AZ資源池VPN網關訂購
接口約束
支持集群模式資源池。
URI
POST /v4/vpn/vpn-gateway/new
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| vpnName | 是 | String | VPN網關名字 | vpc-9ce5 | |
| clientToken | 否 | String | 客戶端存根，用于保證訂單冪等性。要求單個云平臺賬戶內唯一。 | 111263 | |
| regionID | 是 | String | 資源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpcID | 是 | String | vpc ID | vpc-6jwowr794e | |
| vpnType | 是 | String | VPN網關類型，取值范圍: [1,2,3] 1為訂購IPSEC，2為訂購SSL，3為同時訂購IPSEC和SSL |
1 | |
| gatewayType | 是 | String | 網關類型，取值范圍： normal：為普通類型 secret：為國密類型 |
normal | |
| billMode | 是 | String | 網關付費類型，取值范圍： 1：為包周期 2：為按需 |
1 | |
| projectID | 否 | String | 企業項目ID | "0" | |
| sslBandwidth | 否 | Integer | SSL帶寬，單位為Mbps，當vpnType為2和3時,此項為必填 | 10 | |
| sslConnectionLimit | 否 | String | SSLVPN網關連接數限制，當vpnType為2和3時,此項為必填，取值為：["5","10","20","50","100","200","500","1000"] | 10 | |
| sslCycleType | 否 | String | SSL定購類型，取值范圍： MONTH：按月計費，最大支持36個月，當vpnType為2和3時,此項為必填 |
MONTH | |
| sslCycleCount | 否 | Integer | 訂購周期，最大支持36個月，當vpnType為2和3時,此項為必填 | 10 | |
| sslDescription | 否 | String | SSL描述信息 | ssl1 | |
| localSubnets | 是 | Array of Objects | 子網信息 | localSubnets | |
| ipsecBandwidth | 否 | Integer | IPSEC帶寬，單位為Mbps，當vpnType為1和3時,此項為必填 | 10 | |
| ipsecConnectionLimit | 否 | String | IPSECVPN網關連接數限制，當vpnType為1和3時,此項為必填，取值為：["10","20","30","40","50","100"] | 10 | |
| ipsecCycleType | 否 | String | IPSEC定購類型，取值范圍： MONTH：按月計費，最大支持36個月，當vpnType為1和3時,此項為必填 |
YEAR | |
| ipsecCycleCount | 否 | Integer | IPSEC訂購周期，當vpnType為1和3時,此項為必填 | 2 | |
| ipsecDescription | 否 | String | IPSEC描述信息 | ipsec1 |
表localSubnets
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| subnetID | 否 | String | subnet ID | subnet-a0l1wqi058 | |
| subnetName | 否 | String | subnet name | subnet-9ce5 | |
| cidr | 是 | String | cidr | 10.112.0.0/24 | |
| cidrType | 是 | String | 子網類型，取值范圍:[vpc=vpc,manual=manual] | vpc |
響應參數
| 參數名 | 是否必填 | 類型 | 描述 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回狀態碼 取值范圍: 800：成功 900：失敗 |
800 | |
| message | 否 | String | 失敗時的錯誤描述，一般為英文描述 | ||
| description | 否 | String | 失敗時的錯誤描述，一般為中文描述 | ||
| returnObj | 否 | Object | 返回對象 | returnObj | |
| errorCode | 否 | String | 業務細分碼，為product.module.code三段式碼 | ||
| details | 否 | Object | 錯誤明細。 |
returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| masterOrderNO | 否 | String | 主訂單號 | ||
| regionID | 否 | String | 資源池ID | ||
| masterOrderID | 否 | String | 主訂單ID | ||
| masterResourceID | 否 | String | 主訂單資源ID | ||
| masterResourceStatus | 否 | String | 主訂單資源狀態 | ||
| resources | 否 | Array of Objects | 資源明細列表,參考表Resource | Resource |
表 Resource
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| orderID | 否 | String | 訂單號 | ||
| status | 否 | Integer | 資源狀態 | 2 | |
| isMaster | 否 | Boolean | 是否是主資源項 | ||
| resourceType | 否 | String | 資源類型 | ||
| masterOrderID | 否 | String | 主訂單ID | ||
| updateTime | 否 | Integer | 更新時刻，epoch時戳，毫秒精度 | 1697678947000 | |
| expireTime | 否 | Integer | 過期時刻，epoch時戳，毫秒精度 | 1700357344000 | |
| itemValue | 否 | Integer | 資源規格，VPN網關帶寬大小或VPN連接數 | 5 | |
| startTime | 否 | Integer | 啟動時刻，epoch時戳，毫秒精度 | 1697678944000 | |
| createTime | 否 | Integer | 創建時刻，epoch時戳，毫秒精度 | 1697678863000 | |
| masterResourceID | 否 | String | 主資源ID | ||
| resourceID | 否 | String | 單項資源的變配、續訂、退訂等需要該資源項的ID |
請求示例
請求url
無
請求頭header
無
請求體body
{
"clientToken":"111263",
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"vpnName": "vpc-9ce5",
"vpcID": "vpc-6jwowr794e",
"vpnType":"3",
"sslBandwidth":10,
"sslConnectionLimit":"10",
"ipsecBandwidth":10,
"ipsecConnectionLimit":"10",
"gatewayType": "normal",
"billMode": "1",
"projectID": "0",
"sslCycleType": "MONTH",
"sslCycleCount": 1,
"sslDescription": "SSL612",
"ipsecCycleType": "MONTH",
"ipsecCycleCount": 1,
"ipsecDescription": "ipsec612",
"localSubnets":[
{
"subnetID":"subnet-a0l1wqi058",
"subnetName":"subnet-9ce5",
"cidr":"10.112.0.0/24"}]
}
響應示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"masterOrderID": "addb647c6e1e11ee82db0242ac110009",
"masterResourceID": "1f2f478f988d4ae6bb3a1498e0782caa",
"masterOrderNO": null,
"resources": [
{
"orderID": "c7afcd2ae54547d8b45ba0f881951edc",
"status": 2,
"isMaster": true,
"resourceType": "VPN_GETWAY",
"resourceID": "1f2f478f988d4ae6bb3a1498e0782caa",
"masterOrderID": "addb647c6e1e11ee82db0242ac110009",
"updateTime": 1697678947000,
"expireTime": 1700357344000,
"masterResourceID": "1f2f478f988d4ae6bb3a1498e0782caa",
"itemValue": 5,
"startTime": 1697678944000,
"createTime": 1697678863000
},
{
"orderID": "c7afcd2ae54547d8b45ba0f881951edc",
"status": 2,
"isMaster": false,
"resourceType": "VPN_LINK",
"resourceID": "99c63c587e1e4337a7c5a82414001285",
"masterOrderID": "addb647c6e1e11ee82db0242ac110009",
"updateTime": 1697678947000,
"expireTime": 1700357344000,
"masterResourceID": "1f2f478f988d4ae6bb3a1498e0782caa",
"itemValue": 1,
"startTime": 1697678944000,
"createTime": 1697678863000
}
]
},
"details": "",
"message": "success",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 含義 |
|---|---|
| 800 | 請求成功 |
| 900 | 請求未成功(可能暫時未成功，首次下單后會是訂單處理中,狀態碼為900) |
錯誤碼
| errorCode | 含義 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
| vpn.Order.InProgress | 訂單處理中，可使用訂單ID查詢或使用原clientToken重試下單 |
