接口功能介绍
退订文件系统
接口约束
1.退订文件系统前首先要删除该文件系统下的数据流动策略
URI
POST /v4/hpfs/refund-sfs
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | yc-test1234 | |
| sfsUID | 是 | String | 资源 ID | 73725123-0de1-5424-8115-7da2a24f3dfb | |
| regionID | 是 | String | 资源池 ID | 81f7728662dd11ec810800155d307d5b |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败，详见errorCode) | ||
| message | String | 响应描述 | success | |
| description | String | 响应描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为 product.module.code 三段式码 | sfs.order.inProgress | |
| errorDetail | Object | 错误明细。一般情况下，会对订单侧(bss)的并行文件订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode。其他订单侧(bss)的错误，以sfs.order.procFailed的errorCode统一映射返回，并在errorDetail中返回订单侧的详细错误信息 | errorDetail | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Sfs.Order.InProgress |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 退订订单号，可以使用该订单号确认资源的最终退订状态 | f1b0c83a6c0b479cb605138806b2511a | |
| masterOrderNO | String | 订单号 | ||
| regionID | String | 资源所属资源池 ID | 81f7728662dd11ec810800155d307d5b |
表 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
https://hpfs-global.ctapi.ctyun.cn/v4/hpfs/refund-sfs
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"sfsUID": "73725123-0de1-5424-8115-7da2a24f3dfb",
"clientToken": "yc-test1234"
}
响应示例
{
"returnObj": {
"masterOrderNO": "20230221144950852778",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "f1b0c83a6c0b479cb605138806b2511a"
},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
