查询文件夹引用¶
返回文件夹引用查询的当前结果。
POST https://moi.matrixorigin.cn/newmoi/catalog/folder/ref_list
调用前准备¶
先查询文件列表取得目标文件夹 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件夹 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$FOLDER_ID:要查询引用的文件夹 ID。
调用者需要根卷的读取权限。
请求体¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
文件夹 ID。 |
请求示例¶
curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/folder/ref_list" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
-d '{
"id": '"$FOLDER_ID"'
}'
成功响应¶
成功时返回 200。当前实现返回空数组,不能用该结果确认文件夹没有引用。
{
"code": "OK",
"msg": "OK",
"data": {
"list": []
}
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
array |
当前固定为空数组,不能用于判断是否存在引用。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "id 无效",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
|
传入有效的文件夹 ID。 |
|
|
当前身份没有根卷的读取权限。 |
使用有读取权限的凭据,或联系管理员授权。 |
|
|
服务无法读取引用信息。 |
记录请求时间和错误信息后重试;持续失败时联系支持人员。 |
后续操作¶
需要删除文件夹时,使用文件夹 ID 调用删除文件夹并根据其响应处理结果。
最后更新于