运行看板图表

请求运行指定图表。请求被接受不表示图表结果已生成。

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

调用前准备

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

路径参数

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

路径参数

参数

类型

是否必填

说明

dashboard_id

string

数据看板 ID。

chart_id

string

图表 ID。

成功响应

接口返回 202 时只表示看板图表运行已提交。使用当前数据看板 ID 和图表 ID 查看看板图表结果

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

字段

类型

说明

code

integer

请求受理时为 202。

data

object

图表运行提交结果。

下面表格展开响应示例中的 data 对象;每一行是该对象的一个字段。

字段

类型

说明

chart_id

string

图表 ID。

execution_id

string

图表运行 ID。

status

string

运行状态。

错误响应

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

字段

类型

说明

code

integer 或 string

错误代码或状态码。

message

string

错误信息。

后续操作

使用相同的数据看板 ID 和图表 ID 查看看板图表结果

最后更新于