接口功能介绍
多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 | |
| sslBandwidth | 否 | String | SSL带宽，单位为Mbps，当vpnType为2和3时,此项为必填，取值为：["5","10","20","50","100","200","500","1000"] | 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 | 否 | String | IPSEC带宽，单位为Mbps，当vpnType为1和3时,此项为必填，取值为：["5","10","20","50","100","200","500","1000"] | 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 |
响应参数
| 参数名 | 是否必填 | 类型 | 描述 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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",
"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重试下单 |
