运行图表¶
请求运行指定图表。请求被接受不表示图表结果已生成。
POST https://moi.matrixorigin.cn/newmoi/data-dashboards/{dashboard_id}/charts/{chart_id}/run
调用前准备¶
准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$DASHBOARD_ID:要使用的dashboard_id,通过请求路径指定目标资源。$CHART_ID:要使用的chart_id,通过请求路径指定目标资源。
路径参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
数据看板 ID。 |
|
string |
是 |
图表 ID。 |
请求示例¶
curl -X POST "https://moi.matrixorigin.cn/newmoi/data-dashboards/$DASHBOARD_ID/charts/$CHART_ID/run" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
成功响应¶
请求成功时返回本次操作的数据。写入或运行请求已受理不表示后续处理已经完成;请根据返回状态或后续查询确认结果。
{
"code": 202,
"data": {"chart_id": "chart-001", "execution_id": "exec-001", "status": "submitted"}
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
图表 ID。 |
|
string |
图表运行 ID。 |
|
string |
运行状态。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "请求参数无效",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
路径参数、查询参数或请求体无效。 |
检查请求中的标识和字段。 |
|
|
凭据缺失或无效。 |
检查 API Key。 |
|
|
当前身份没有目标资源的权限。 |
使用有权限的凭据,或联系管理员授权。 |
|
|
目标资源不存在,或当前工作区不可见。 |
检查资源标识和工作区。 |
|
|
服务端无法完成请求。 |
记录请求时间和错误信息后重试。 |
后续操作¶
使用相同标识查询图表结果。
最后更新于