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