更新文件夹

更新文件夹信息;提供 name 时会校验其是否为有效标识符。

POST https://moi.matrixorigin.cn/newmoi/catalog/folder/update

调用前准备

查询文件列表取得目标文件夹 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件夹 ID。

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $FOLDER_ID:要更新的文件夹 ID。

调用者需要根卷的写入权限。

请求体

参数

类型

是否必填

说明

id

integer

文件夹 ID。

name

string

新名称。

description

string

新描述。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/folder/update" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$FOLDER_ID"',
    "name": "<FOLDER_NAME>",
    "description": "<FOLDER_DESCRIPTION>"
  }'

成功响应

成功时返回 200datanull。调用者需要根卷的写入权限。

{
  "code": "OK",
  "msg": "OK",
  "data": null
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

null

更新成功时固定为 null

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "name 无效",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

请求格式无效,或提供的 name 无效。

检查文件夹 ID 和名称。

403

ErrForbidden

当前身份没有根卷的写入权限。

使用有写入权限的凭据,或联系管理员授权。

409

ErrReadonly

文件夹所在数据库不可写。

选择可写卷中的文件夹。

500

ErrServer

服务无法更新文件夹。

记录请求时间和错误信息后重试;持续失败时联系支持人员。

后续操作

用同一资源标识查询 Catalog 详情确认更新结果。

最后更新于