# 查询数据看板详情

读取指定数据看板及其数据源和图表配置。

```text
GET https://moi.matrixorigin.cn/newmoi/data-dashboards/{dashboard_id}
```

## 调用前准备

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

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。

- `$DASHBOARD_ID`：要使用的 `dashboard_id`，通过请求路径指定目标资源。

## 路径参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `dashboard_id` | string | 是 | 数据看板 ID。 |
## 请求示例

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

## 成功响应

查询成功时返回数据看板、数据源、图表和告警信息。

```json
{
  "code": 0,
  "data": {
    "ID": "0198ce73-3d20-7c12-9a11-1a2b3c4d5e6f",
    "Name": "销售概览",
    "Description": "按日查看销售数据",
    "CreatedByRoleID": "role-001",
    "CreatedAt": "2026-08-21T07:00:00Z",
    "UpdatedAt": "2026-08-21T07:00:00Z",
    "sources": [
      {
        "ID": "source-001",
        "DashboardID": "0198ce73-3d20-7c12-9a11-1a2b3c4d5e6f",
        "TableID": 1001,
        "DatabaseName": "analytics",
        "TableName": "daily_sales",
        "CreatedAt": "2026-08-21T07:00:00Z"
      }
    ],
    "charts": [],
    "alerts": [],
    "active_alert_count": 0
  }
}
```

响应字段如下。

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `data.ID` | string | 数据看板 ID。 |
| `data.Name` | string | 数据看板名称。 |
| `data.Description` | string | 数据看板说明。 |
| `data.CreatedByRoleID` | string | 创建数据看板时使用的角色 ID。 |
| `data.CreatedAt` | string | 创建时间。 |
| `data.UpdatedAt` | string | 更新时间。 |
| `data.sources` | array | 数据源列表。 |
| `data.sources[].ID` | string | 数据源关联记录 ID。 |
| `data.sources[].DashboardID` | string | 数据看板 ID。 |
| `data.sources[].TableID` | integer | 数据表 ID。 |
| `data.sources[].DatabaseName` | string | 数据库名称。 |
| `data.sources[].TableName` | string | 数据表名称。 |
| `data.sources[].CreatedAt` | string | 数据源关联记录的创建时间。 |
| `data.charts` | array | 图表列表；详情响应中返回。 |
| `data.alerts` | array | 告警记录列表。 |
| `data.active_alert_count` | integer | 当前处于告警状态的图表数量。 |

## 错误响应

```json
{
  "code": 3,
  "message": "not found",
  "details": {
    "domain": "moi-core.catalog.data_dashboard",
    "reason": "DATA_DASHBOARD_NOT_FOUND"
  }
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 响应 `code`
  - 常见原因
  - 建议操作
* - `400`
  - `2`
  - 路径参数、查询参数或请求体无效。
  - 检查请求中的标识和字段。
* - `401`
  - `6`
  - 凭据缺失或无效。
  - 检查 API Key。
* - `403`
  - `5`
  - 当前身份没有目标资源的权限。
  - 使用有权限的凭据，或联系管理员授权。
* - `404`
  - `3`
  - 目标资源不存在，或当前工作区不可见。
  - 检查资源标识和工作区。
* - `409`
  - `4`
  - 资源正在执行其他操作。
  - 检查资源状态后重试。
* - `500`
  - `1`
  - 服务端无法完成请求。
  - 记录请求时间和错误信息后重试。
* - `503`
  - `15`
  - 数据看板服务或其依赖暂时不可用。
  - 稍后重试。
```