刷新全部图表

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

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

调用前准备

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

下方示例使用:

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

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

  • $DASHBOARD_ID:要使用的 dashboard_id,通过请求路径指定目标资源。

路径参数

参数

类型

是否必填

说明

dashboard_id

string

数据看板 ID。

请求示例

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

成功响应

请求成功时返回本次操作的数据。写入或运行请求已受理不表示后续处理已经完成;请根据返回状态或后续查询确认结果。

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

响应字段如下。

本文中,字段路径中的 [] 表示数组中的每一项。例如,items[].name 表示 items 数组中每一项的 name 字段。

字段

类型

说明

data.runs

array

各图表的刷新提交结果。

data.runs[].chart_id

string

图表 ID。

data.runs[].execution_id

string

图表运行 ID;提交成功时返回。

data.runs[].status

string

该图表的提交状态。

data.runs[].error

string

提交失败原因;失败时返回。

错误响应

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

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

路径参数、查询参数或请求体无效。

检查请求中的标识和字段。

401

ErrUnauthorized

凭据缺失或无效。

检查 API Key。

403

ErrPermissionDenied

当前身份没有目标资源的权限。

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

404

ErrNotFound

目标资源不存在,或当前工作区不可见。

检查资源标识和工作区。

500

ErrServer

服务端无法完成请求。

记录请求时间和错误信息后重试。

最后更新于