刷新全部看板图表

请求刷新指定数据看板中的全部图表。每个图表独立提交，需检查各自的返回状态。

POST https://api.moi.matrixorigin.cn/v5/data-dashboards/{dashboard_id}/refresh

调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID，分别通过 X-API-Key 和 X-Workspace-ID 请求头传递。从查看数据看板列表的列表中选择所需数据看板的 ID，写入请求路径中的 $DASHBOARD_ID。

路径参数

调用示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/data-dashboards/$DASHBOARD_ID/refresh" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

路径参数

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

成功响应

接口返回 202 时只表示各看板图表的刷新任务已提交。使用当前数据看板 ID 和每个刷新结果中的 chart_id 查看看板图表结果。

响应示例

{
  "code": 202,
  "data": {
    "runs": [
      {
        "chart_id": "chart-001",
        "execution_id": "exec-001",
        "status": "submitted"
      }
    ]
  }
}

字段说明

通用字段

字段	类型	说明
code	integer	请求受理时为 202。
data	object	刷新提交结果。
runs	array	各图表的刷新提交结果。

刷新结果

下面表格展开响应示例中 data 下的 runs 列表；每一行是列表中一个图表的刷新提交结果。

字段	类型	说明
chart_id	string	图表 ID。
execution_id	string	图表运行 ID；提交成功时返回。
status	string	该图表的提交状态。
error	string	提交失败原因；失败时返回。

错误响应

响应示例

{
  "code": 400,
  "message": "请求参数无效"
}

字段说明

字段	类型	说明
code	integer 或 string	错误代码或状态码。
message	string	错误信息。

最后更新于 2026 年 9 月 28 日