接口功能介绍
支持退订按天购买的智能网关弹性带宽包。退订后,将退还对应部分弹性带宽包费用。
接口约束
输入参数名称类长度不超过64位,描述类长度不超过128位
URI
POST /v4/sdwan/elastic-bandwidth-package/refund
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 否 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一。 | ||
resourceID | 是 | String | 弹性带宽包资源ID |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 否 | Integer | 返回状态码(800为成功,900为失败) | 800 | |
message | 否 | String | 失败时的错误描述,一般为英文描述 | ||
description | 否 | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | 否 | Object | 返回对象 | returnObj | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
masterOrderID | 否 | String | 订单ID。调用方在拿到masterOrderID之后,在若干错误情况下,可以使用materOrderID进一步确认订单状态及资源状态。 | ||
masterOrderNO | 否 | String | 订单号 | ||
regionID | 否 | String | 对于SDWAN产品为空 |
请求示例
请求头header
无
请求体body
{
"clientToken": "any-uniqure-string",
"resourceID": "6f887fa6d89f4617a5a21c7955a15e22"
}
响应示例
{
"returnObj": {
"masterOrderNO": "20230223190438616431",
"regionID": null,
"masterOrderID": "abe476445e4411edb4f40242ac110003"
},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求未成功(可能暂时未成功,首次下单后会是订单处理中,状态码为900) |
错误码
errorCode | 含义 |
---|---|
Sdwan.Order.AccessFailed | 订单系统访问失败,可使用clientToken重试订单 |
Sdwan.Order.InProgress | 订单处理中,可使用订单ID查询确认或使用原clientToken重试下单 |
Sdwan.Order.ProcFailed | 订单处理失败。无需重试。通过errorDetail确认具体失败原因 |
Sdwan.Order.OrderChanged | 订单状态变更,比如发生了撤单,取消等 |