接口功能介绍
在指定地域续租一个某种计费模式的网关资源
接口约束
1、用户需要已创建至少一个网关资源
2、续租某个网关需要该网关资源没有被删除，且续租不会改变该网关的任何规格和参数
3、仅支持onDemand 为 false 的资源进行续租，续租周期最大长度不能超过 36个月
URI
POST /v4/nfs/renew-nfs-gateway
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 | |
| gatewayID | 是 | String | 网关的ID | 参考请求示例 | |
| cycleCount | 是 | Integer | 包周期数，周期最大长度不能超过 36个月 | 1 | |
| cycleType | 是 | String | 包周期类型，①MONTH：月（目前仅支持以月为单位续租） | 参考请求示例 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败) | 800 | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 响应对象 | 参考表returnObj | |
| error | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码大驼峰形式 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderNO | String | 订单号 | 参考响应示例 | |
| regionID | String | 资源池ID | 参考响应示例 | |
| masterOrderID | String | 订单ID，调用方在拿到masterOrderID之后，在若干错误情况下，可以使用 materOrderID 进一步确认订单状态及资源状态 | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"gatewayID":"8a26498c-c0c8-11ee-ae9f-18022d1723b2",
"regionID":"81f7728662dd11ec810800155d307d5b",
"cycleCount":2,
"cycleType":"MONTH"
}
响应示例
{
"description":"订单处理中，可使用订单ID查询或使用原clientToken重试下单",
"returnObj":{
"masterOrderNO":"20240227170330757997",
"regionID":"81f7728662dd11ec810800155d307d5b",
"masterOrderID":"31af2b7704f642ce8a76f7c404517507"
},
"errorCode":"hsg.order.inProgress",
"details":"",
"error":"Hsg.Order.InProgress",
"message":"order in progress",
"statusCode":900
}
状态码
请参考 状态码
错误码
请参考 错误码
