接口功能介绍
支持VPN网关包周期计费的续订询价。
接口约束
用户VPN网关非按需订单下单成功。
URI
POST /v4/vpn/gateway/query-price-renew
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID, 例:100054c0416811e9a6690242ac110002 | ||
| resourceID | 是 | 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三段式码 |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| discountPrice | 否 | Float | 订单折扣 | ||
| totalPrice | 否 | Float | 所有订单总共价格 | ||
| finalPrice | 否 | Float | 所有订单最终价格 | ||
| customPrice | 否 | Float | 订单客户价格 | ||
| originPrice | 否 | Float | 订单原价格 | ||
| isSucceed | 否 | Boolean | 是否成功 | ||
| subOrderPrices | 否 | Array of Objects | 子订单价格列表 | orderPrice |
表 0rderPrice
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| discountPrice | 否 | Float | 订单折扣 | ||
| seq | 否 | String | 订单序列 | ||
| originPrice | 否 | float | 订单原有价格 | ||
| serviceTag | 否 | String | 产品标签 | ||
| totalPrice | 否 | Float | 订单总共价格 | ||
| finalPrice | 否 | Float | 订单最终价格 | ||
| customPrice | 否 | Float | 订单客户价格 | ||
| cycleType | 否 | String | 订单周期类型 | ||
| orderItemPrices | 否 | Array of Objects | 订单资源价格列表 | orderItemPrice |
表 orderItemPrice
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| itemId | String | 订单资源ID | ||
| customPrice | Float | 订单客户价格 | ||
| originPrice | Float | 订单原价格 | ||
| discountPrice | Float | 订单折扣 | ||
| resourceType | String | 本参数表示订单资源类型。 取值范围： VPN_GETWAY VPN_LINK |
||
| totalPrice | Float | 订单资源总共价格 | ||
| finalPrice | Float | 订单资源最终价格 |
请求示例
请求url
无
请求头header
无
请求体body
可使用同clientToken重试下单，查询订单是否成功
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"cycleType": "MONTH",
"cycleCount": 1,
"resourceID": "6f887fa6d89f4617a5a21c7955a15e22"
}
响应示例
{
"returnObj": {
"discountPrice": null,
"totalPrice": 2760.0,
"isSucceed": true,
"subOrderPrices": [{
"discountPrice": null,
"totalPrice": 2760.0,
"seq": null,
"serviceTag": "OVMS",
"orderItemPrices": [{
"itemId": "2c5969cab14a4015b9642f92812a2ce9",
"discountPrice": null,
"totalPrice": 1720.0,
"resourceType": "VPN_GETWAY",
"finalPrice": 1720.0,
"customPrice": null,
"originPrice": null}, {
"itemId": "d3e27387a2824e5390ed970e742efbd2",
"discountPrice": null,
"totalPrice": 1040.0,
"resourceType": "VPN_LINK",
"finalPrice": 1040.0,
"customPrice": null,
"originPrice": null}],
"finalPrice": 2760.0,
"cycleType": null,
"customPrice": null,
"originPrice": null}],
"finalPrice": 2760.0,
"customPrice": null,
"originPrice": null
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| vpn.RegionInfo.Empty | 资源池信息为空，可能资源池ID不正确 |
| vpn.ResourceInfo.NotExists | 资源信息不存在(详情) |
| Openapi.Parameter.Error | 请求参数错误 |
