退订存储库
更新时间 2026-04-02 15:41:08
最近更新时间: 2026-04-02 15:41:08
接口功能介绍
退订存储库
接口约束
1、退订存储库会删除此存储库所关联的所有备份资源，包括备份计划、备份任务、备份数据、恢复任务，同时会导致正在执行的备份、恢复任务失败
URI
POST /v4/backup/refund-storage-backup
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | storage-test | |
| backupStorageID | 是 | String | 要退订的存储库ID | 770fb5e7-7f84-423c-9dd4-2eaf7912d5bc | |
| regionID | 是 | String | 资源池ID | 41f64827f25f468595ffa3a5deb5d15d |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| message | String | 成功或失败时的描述，一般为英文描述 | SUCCESS | |
| description | String | 成功或失败时的描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码。 | backup.regionInfo.empty | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Backup.RegionInfo.Empty |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用masterOrderID进一步确认订单状态及资源状态 | 参考响应示例 | |
| masterOrderNO | String | 订单号 | 参考响应示例 | |
| regionID | String | 资源池ID | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"clientToken":"storage-test",
"backupStorageID":"770fb5e7-7f84-423c-9dd4-2eaf7912d5bc",
"regionID":"41f64827f25f468595ffa3a5deb5d15d"
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"description": "订单处理中，可使用订单ID查询或使用原clientToken重试下单",
"returnObj": {
"masterOrderNO": "20231208105246440671",
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"masterOrderID": "71853412cd6b4e9e97f42d949732b8ab"
},
"errorCode": "backup.order.inProgress",
"error": "Backup.Order.InProgress",
"message": "order in progress",
"statusCode": 900
}
}
用重复的clientToken和相同参数继续执行，完成后会返回：
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"masterOrderNO": "20231208105246440671",
"regionID": "bb9fdb42056f11eda1610242ac110002",
"masterOrderID": "71853412cd6b4e9e97f42d949732b8ab"
},
"details": "",
"message": "success",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
