接口介绍
退订文件系统
接口约束
- 海量文件下没有绑定挂载点/vpc
URI
POST /v4/oceanfs/refund-sfs
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | 参考请求示例 | |
| sfsUID | 是 | String | 弹性文件功能系统唯一 ID | 参考请求示例 | |
| regionID | 是 | String | 资源池 ID | 参考请求示例 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码(800 为成功，900 为失败) | 800 | |
| message | 是 | String | 响应描述，一般为英文描述 | SUCCESS | |
| description | 是 | String | 响应描述，一般为中文描述 | 成功 | |
| returnObj | 否 | Object | 参考returnObj | 参考returnObj | 表returnObj |
| errorCode | 否 | String | 业务细分码，为 product.module.code 三段式码 | 参考结果码 | |
| error | 否 | String | 业务细分码，为product.module.code三段式码大驼峰形式 | 参考结果码 |
returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterOrderID | 是 | String | 退订订单号，可以使用该订单号确认资源的最终退订状态 | 参考响应示例 | |
| masterOrderNO | 否 | String | 订单号 | 参考响应示例 | |
| regionID | 是 | String | 资源所属资源池 ID | 参考响应示例 |
请求示例
请求头
无
请求体 body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"sfsUID": "e828a6e7-e1ed-5528-968a-9dd7077395d2",
"clientToken": "yc-test1234"
}
响应示例
{
"returnObj": {
"masterOrderNO": "20230221144950852778",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "f1b0c83a6c0b479cb605138806b2511a"
},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 说明 |
|---|---|
| 200 | 表示请求成功 |
错误码
请参考错误码说明
