接口功能介绍
退订文件系统
接口约束
1.弹性文件下没有绑定挂载点/vpc
2.自2024年10月15日起，本接口会受到IAM权限管控，当子账号或委托调用该接口时，需具备“sfs:shares:delete”权限，否则会报权限不足的错误。
URI
POST /v4/sfs/refund-sfs
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | 参考[请求示例] | |
| sfsUID | 是 | String | 弹性文件功能系统唯一 ID | 参考[请求示例] | |
| regionID | 是 | String | 资源池 ID | 参考[请求示例] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败/订单处理中) | 800 | |
| message | String | 响应描述，一般为英文描述 | 参考[结果码] | |
| description | String | 响应描述，一般为中文描述 | 参考[结果码] | |
| returnObj | Object | 参考[returnObj] | returnObj | |
| errorCode | String | 业务细分码，为 product.module.code 三段式码.参考[结果码] | 参考[结果码] | |
| error | String | 业务细分码，为product.module.code三段式码大驼峰形式 | 参考[结果码] | |
| errorDetail | Object | 错误明细。一般情况下，会对订单侧(bss)的弹性文件订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。其他订单侧(bss)的错误，以sfs.order.procFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息 | errorDetail |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 退订订单号，可以使用该订单号确认资源的最终退订状态 | 参考[响应示例] | |
| masterOrderNO | String | 订单号 | 参考[响应示例] | |
| regionID | String | 资源所属资源池 ID | 参考[响应示例] |
表 errorDetail
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bssErrCode | String | bss错误明细码，包含于bss格式化JSON错误信息中 | code_foo | |
| bssErrMsg | String | bss错误信息，包含于bss格式化JSON错误信息中 | error_foo | |
| bssOrigErr | String | 无法明确解码bss错误信息时，原样透出的bss错误信息 | unknow_error | |
| bssErrPrefixHint | String | bss格式化JSON错误信息的前置提示信息 | error_bar |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"sfsUID":"e828a6e7-e1ed-5528-968a-9dd7077395d2",
"clientToken":"yc-test1234"
}
响应示例
{
"returnObj":{
"masterOrderNO":"20230221144950852778",
"regionID":"81f7728662dd11ec810800155d307d5b",
"masterOrderID":"f1b0c83a6c0b479cb605138806b2511a"
},
"message":"success",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码
