调用本接口,开发者可以查询通过文件上传接口上传的文件详情信息。
前提条件
在调用本接口前,请先完成下述事项:
请求地址
GEThttps://api.tbox.cn/api/file/retrieve?fileId={fileId}
请求头
参数名称 |
是否必填 |
参数类型 |
描述 |
示例值 |
Authorization |
是 |
string |
用于验证客户端身份的访问令牌,你可以在百宝箱中获取,获取方式可参见:授权管理。 |
|
Content-Type |
是 |
string |
指定返回数据的格式 |
|
请求参数
参数名称 |
是否必填 |
参数类型 |
描述 |
示例值 |
fileId |
是 |
string |
已上传的文件 ID |
|
请求示例
curl -X GET 'https://api.tbox.cn/api/file/retrieve?fileId=123ddf32ddd' \ -H "Authorization: ${token}" \ -H "Content-Type: application/json"
返回参数
参数名称 |
参数类型 |
描述 |
示例值 |
errorCode |
String |
状态码,非 0 表示失败 |
0 |
errorMsg |
String |
状态描述 |
success |
data |
object |
文件详情对象 |
见下方示例 |
data.id |
string |
文件 ID |
|
data.fileName |
string |
文件名 |
|
data.fileType |
string |
文件类型 |
|
data.bytes |
string |
文件大小(字节数) |
|
data.gmtCreate |
string |
文件创建时间 |
|
traceId |
String |
本次请求的唯一标识 |
0be8ed*********44067999e8721 |
返回示例
成功示例
{ "data": { "bytes": 666, "fileName": "test.txt", "fileType": "txt", "gmtCreate": "2025-08-04 23:04:37", "id": "123ddf32ddd" }, "errorCode": "0", "errorMsg": "success", "traceId": "0b446a2817550027034776634e09f1" }
失败示例
{ "errorCode": "P_1_02_111", "errorMsg": "资源不存在", "solution": "", "traceId": "0be8ed2517550025084902701ec9f5" }