查看文件夹引用¶
返回文件夹引用查询的当前结果。
POST https://api.moi.matrixorigin.cn/v5/catalog/folder/ref_list
调用前准备¶
先查询文件列表取得目标文件夹 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件夹 ID。 调用者需要根卷的读取权限。
请求体¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/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"'
}'
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
文件夹 ID。 |
成功响应¶
成功时返回 200。当前实现返回空数组,不能用该结果确认文件夹没有引用。
{
"code": "OK",
"msg": "OK",
"data": {
"list": []
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
下面表格展开响应示例中 data 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
array |
当前固定为空数组,不能用于判断是否存在引用。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "id 无效",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
错误信息。 |
|
null |
错误响应中的附加数据;本示例为 |
后续操作¶
需要删除文件夹时,使用文件夹 ID 调用删除文件夹并根据其响应处理结果。
最后更新于