删除 Catalog¶
删除指定 Catalog。删除不可逆;应先查询引用并处理下级对象。
POST https://moi.matrixorigin.cn/newmoi/catalog/delete
调用前准备¶
先查询 Catalog 引用并处理下级对象,再查询 Catalog 列表确认目标 Catalog ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和 Catalog ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$CATALOG_ID:要删除的 Catalog ID。
请求体¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
要删除的 Catalog ID。 |
请求示例¶
curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/delete" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
-d '{
"id": '"$CATALOG_ID"'
}'
成功响应¶
成功时返回 200,data 为 null。
{
"code": "OK",
"msg": "OK",
"data": null
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
null |
删除成功时固定为 |
错误响应¶
{
"code": "ErrCatalogHasChildren",
"msg": "Catalog 包含下级对象",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
请求体或 Catalog ID 无效。 |
使用列表返回的正整数 ID。 |
|
|
当前身份没有删除权限。 |
请求授予 |
|
|
目标是只读系统 Catalog。 |
不要删除该 Catalog。 |
|
|
Catalog 仍包含下级对象。 |
先删除或迁移下级对象。 |
|
|
Catalog 正被知识库使用。 |
处理知识库依赖后再删除。 |
|
|
服务端未能删除 Catalog。 |
稍后重试。 |
后续操作¶
查询文件产物,确认目标已不再出现。
最后更新于