更新看板图表¶

更新指定图表的查看、展示和刷新配置。

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

调用前准备¶

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

请求体¶

将示例中的调用者专属值替换为实际值。

输入示例

curl -X PATCH "https://api.moi.matrixorigin.cn/v5/data-dashboards/$DASHBOARD_ID/charts/$CHART_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "每日订单数",
    "chart_type": "line",
    "sql_text": "SELECT 1",
    "chart_config": "{}",
    "layout_config": "{}",
    "refresh_interval": "manual",
    "alert_enabled": false,
    "alert_config": "{}"
  }'

参数说明

参数	类型	是否必填	说明
`name`	string	是	图表名称。
`chart_type`	string	是	图表类型。
`sql_text`	string	是	图表 SQL。
`chart_config`	string	是	图表配置。
`layout_config`	string	是	布局配置。
`refresh_interval`	string	是	刷新周期。
`alert_enabled`	boolean	是	是否启用告警。
`alert_config`	string	是	告警配置。

成功响应¶

更新成功时返回更新后的图表和调度状态。

响应示例

{
  "code": 0,
  "data": {
    "ID": "0198ce79-2320-76aa-9d34-7f8e9d0c1b2a",
    "DashboardID": "0198ce73-3d20-7c12-9a11-1a2b3c4d5e6f",
    "Name": "每日订单数",
    "ChartType": "line",
    "SQLText": "SELECT 1",
    "DatabaseName": "analytics",
    "ChartConfig": "{}",
    "LayoutConfig": "{}",
    "RefreshInterval": "manual",
    "SchedulerTaskID": "",
    "ScheduleVersion": 2,
    "ScheduleStatus": "ready",
    "ScheduleError": "",
    "ScheduleOperationID": "operation-002",
    "AlertEnabled": false,
    "AlertConfig": "{}",
    "SnapshotEpochAt": "2026-08-21T07:10:00Z",
    "CreatedAt": "2026-08-21T07:00:00Z",
    "UpdatedAt": "2026-08-21T07:10:00Z"
  }
}

字段说明

通用字段

字段	类型	说明
code	integer	成功时为 0。
data	object	更新后的图表。

图表

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

字段	类型	说明
ID	string	图表 ID。
DashboardID	string	所属数据看板 ID。
Name	string	图表名称。
ChartType	string	图表类型。
SQLText	string	图表 SQL。
DatabaseName	string	图表查询使用的数据库名称。
ChartConfig	string	图表配置。
LayoutConfig	string	布局配置。
RefreshInterval	string	刷新周期。
SchedulerTaskID	string	调度任务 ID；未创建调度任务时为空。
ScheduleVersion	integer	调度配置版本。
ScheduleStatus	string	调度状态。
ScheduleError	string	调度错误；没有错误时为空。
ScheduleOperationID	string	本次调度操作 ID。
AlertEnabled	boolean	是否启用告警。
AlertConfig	string	告警配置。
SnapshotEpochAt	string	结果快照起始时间。
CreatedAt	string	创建时间。
UpdatedAt	string	更新时间。

错误响应¶

响应示例

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

字段说明

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

最后更新于 2026 年 9 月 28 日