批量解析工作区名称¶

按工作区 ID 批量解析名称，并返回可解析项的 ID 和名称。

POST https://api.moi.matrixorigin.cn/v5/data-share/workspaces/resolve-names

调用前准备¶

准备可访问目标工作区的个人访问令牌、目标工作区 ID 和要解析的工作区 ID 列表。

请求体¶

示例使用 jq 构造 JSON 请求体。运行前安装 jq，并设置示例中的环境变量。不要再次编码 jq 生成的 JSON。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/data-share/workspaces/resolve-names" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  --data-binary "$(jq -n --arg TARGET_WORKSPACE_ID "$TARGET_WORKSPACE_ID" '
{
  "ids": [
    $TARGET_WORKSPACE_ID
  ]
}
')"

参数说明

ID 列表可省略、填 null 或 []。服务会忽略空项并去重，保留首次出现的顺序，最多查询 200 个不同的 ID。

无需存在共享关系，仅返回状态正常的工作区 ID 和名称。未找到的项会省略，读取失败时返回错误。查询到名称不代表具有该工作区的访问权限。

字段	类型	是否必填	说明
`ids`	string（字符串数组）	否	待解析的工作区 ID。可省略、null 或空数组，最多 200 个去重 ID。

成功响应¶

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workspaces": [
      {
        "id": "ws-02",
        "name": "分析工作区"
      }
    ]
  }
}

字段说明

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。
`data.workspaces`	object（对象数组）	可解析的工作区列表。
`data.workspaces[].id`	string	工作区 ID。
`data.workspaces[].name`	string	工作区名称。

错误响应¶

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误说明。
`data`	null	错误时为空。

常见 HTTP 错误¶

HTTP 状态码	错误代码	常见原因	建议操作
400	`ErrWorkspaceRequired`、`ErrParamInvalid`	请求字段、工作区或操作前置条件无效。	修正参数后再提交。
403	`ErrPermissionDenied`	当前身份或有效角色无执行该操作的权限。	使用有权限的身份，或联系管理员授权。
404	`ErrSourceNotFound`	目标对象或所需引用未找到。	核对对象标识、所属工作区和当前状态。
500	`ErrServer`	内部处理失败；写操作可能已有部分效果。	保留请求和追踪信息，先核对当前结果。
503	`ErrServiceUnavailable`	业务、运行时或授权依赖暂不可用。	恢复依赖后先核对已有结果，不自动重复写入。

最后更新于 2026 年 10 月 19 日