接口功能介绍
VPN网关升配，目前只支持升配:增加带宽和连接数。
接口约束
支持集群模式资源池，并且升配后VPN网关配额未满；用户账户余额充足，该接口无法使用优惠券支付，若余额不足会创建一个待支付订单。
URI
POST /v4/vpn/vpn-gateway/upgrade
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。 | uniqureAnyString | |
| regionID | 是 | String | 资源池ID | 100054c0416811e9a6690242ac110002 | |
| vpnType | 是 | String | VPN网关类型，取值范围: [1,2] 1为IPSEC类型VPN，2为SSL类型VPN |
1 | |
| bandwidth | 是 | String | 带宽，单位为Mbps，取值为：["5","10","20","50","100","200","500","1000"] | 10 | |
| connectionLimit | 是 | String | VPN网关连接数限制 当vpnType为1时，取值为：["10","20","30","40","50","100"] 当vpnType为2时，取值为：["5","10","20","50","100","200","500","1000"] |
20 | |
| resourceID | 是 | String | VPN网关资源ID | 6f887fa6d89f4617a5a21c7955a15e22 | |
| linkResourceID | 是 | String | VPN连接资源ID | a9c27f76ad7a4a6888e1e51848de652c |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800：成功 900：失败 |
||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回对象 | returnObj | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterOrderID | 否 | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态。 | ||
| masterOrderNO | 否 | String | 订单号 | ||
| regionID | 否 | String | 资源池ID |
请求示例
请求url
无
请求头header
无
请求体body
可使用同clientToken重试下单，查询订单是否成功
{
"clientToken": "uniqureAnyString",
"regionID": "81f7728662dd11ec810800155d307d5b",
"bandwidth": "10",
"vpnType":"1",
"connectionLimit": "20",
"resourceID": "6f887fa6d89f4617a5a21c7955a15e22",
"linkResourceID": "a9c27f76ad7a4a6888e1e51848de652c"
}
响应示例
{
"returnObj": {
"masterOrderNO": 898292929,
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "abe476445e4411edb4f40242ac110003"
},
"details": "",
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 表示请求未成功(可能暂时未成功，首次下单后会是订单处理中,状态码为900) |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| vpn.Order.InProgress | 订单处理中，可使用订单ID查询或使用原clientToken重试下单 |
| vpn.ResourceInfo.NotExists | 资源信息不存在(详情) |
