查看文件详情

按文件 ID 查询文件详情。

POST https://api.moi.matrixorigin.cn/v5/catalog/file/info

调用前准备

查询文件列表上传文件取得目标文件 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件 ID。 调用者需要文件所属根卷的读取权限。

请求体

curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/file/info" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "file_id": "'"$FILE_ID"'"
  }'

字段

类型

必填

说明

file_id

string

文件 ID。

成功响应

成功时返回 200 和文件信息。调用者需要文件所属根卷的读取权限。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "file_id": "file-123",
    "file_name": "orders.csv",
    "size": "2048"
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

下面表格展开响应示例中 data 对象;每一行是该对象的一个字段。

字段

类型

说明

file_id

string

文件 ID。

file_name

string

文件名。

size

string

文件大小,单位为字节,以数值字符串返回。

错误响应

{
  "code": "ErrNotFound",
  "msg": "对象不存在",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

错误响应中的附加数据;本示例为 null

后续操作

需要修改时更新文件。返回列表时查询文件产物

最后更新于