更新数据看板¶

更新指定数据看板的名称、说明和数据源。

PATCH https://moi.matrixorigin.cn/newmoi/data-dashboards/{dashboard_id}

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

$AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。
$WORKSPACE_ID：目标工作区 ID，通过 X-Workspace-ID Header 传递。
$DASHBOARD_ID：要使用的 dashboard_id，通过请求路径指定目标资源。

路径参数¶

参数	类型	是否必填	说明
`dashboard_id`	string	是	数据看板 ID。

请求体¶

本文中，字段路径中的 [] 表示数组中的每一项。例如，sources[].table_id 表示 sources 数组中每一项的 table_id 字段。

参数	类型	是否必填	说明
`name`	string	是	数据看板名称。
`description`	string	是	数据看板说明。
`sources`	array	是	数据源列表。
`sources[].table_id`	integer	是	数据源表 ID。

请求示例¶

curl -X PATCH "https://moi.matrixorigin.cn/newmoi/data-dashboards/$DASHBOARD_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "销售概览",
    "description": "更新后的说明",
    "sources": [{"table_id": 1001}]
  }'

成功响应¶

更新成功时，响应中的 data.updated 为 true。

{
  "code": 0,
  "data": {"updated": true}
}

响应字段如下。

字段	类型	说明
`data.updated`	boolean	是否已更新。

错误响应¶

{
  "code": 2,
  "message": "invalid argument",
  "details": {
    "domain": "moi-core.catalog.data_dashboard",
    "reason": "DATA_DASHBOARD_INVALID_REQUEST"
  }
}

常见 HTTP 错误¶

HTTP 状态码	响应 `code`	常见原因	建议操作
`400`	`2`	路径参数、查询参数或请求体无效。	检查请求中的标识和字段。
`401`	`6`	凭据缺失或无效。	检查 API Key。
`403`	`5`	当前身份没有目标资源的权限。	使用有权限的凭据，或联系管理员授权。
`404`	`3`	目标资源不存在，或当前工作区不可见。	检查资源标识和工作区。
`409`	`4`	资源正在执行其他操作，或操作版本已过期。	重新查询资源状态后重试。
`500`	`1`	服务端无法完成请求。	记录请求时间和错误信息后重试。
`503`	`15`	数据看板服务或其依赖暂时不可用。	稍后重试。

最后更新于 2026 年 8 月 22 日