物理专线云端口退订
更新时间 2025-12-10 16:14:05
最近更新时间: 2025-12-10 16:14:05
接口功能介绍
支持退订一个端口计费的云端口。退订后，将退还对应部分云端口费用。
接口约束
云端口已下单。
URI
POST /v4/cda/physical-line/refund
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一。 | new1order2test3for4vpn110701 | |
| resourceID | 是 | String | 云端口订单资源ID | 6f887fa6d89f4617a5a21c7955a15e22 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码 取值范围: 800：成功 900：失败 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| details | Object | 错误明细。一般情况下，会对订单侧(bss)的VPN网关订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态。 | ||
| masterOrderNO | String | 订单号 | ||
| regionID | String | 资源池ID, 例:100054c0416811e9a6690242ac110002 |
枚举参数
无
请求示例
请求url
POST v4/cda/physical-line/refund
请求头header
无
请求体body
{
"clientToken": "test1",
"resourceID": "5e7379f3b5fb4adcbc4cf8bb2fa87184"
}
响应示例
{
"returnObj": {
"masterOrderNO": "20250417101135447415",
"regionID": null,
"masterOrderID": "165f2219c78b4820925473f1e1e4bb43"
},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
