# 预览图表 SQL

执行图表 SQL 预览，返回查询结果而不保存图表。

```text
POST https://moi.matrixorigin.cn/newmoi/data-dashboards/{dashboard_id}/preview
```
## 调用前准备

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

下方示例使用：

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

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

## 路径参数

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

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `sql_text` | string | 是 | 要预览的 SQL。 |
## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/data-dashboards/$DASHBOARD_ID/preview" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "sql_text": "SELECT 1 AS value"
  }'
```

## 成功响应

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

```json
{
  "code": 200,
  "data": {"query_id": "query-001", "statement_id": "stmt-001", "status": "completed", "total": 1}
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `data.query_id` | string | 查询 ID。 |
| `data.statement_id` | string | 语句 ID。 |
| `data.status` | string | 查询状态。 |
| `data.columns` | array | 结果列。 |
| `data.result` | array | 结果数据。 |

## 错误响应

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

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 路径参数、查询参数或请求体无效。
  - 检查请求中的标识和字段。
* - `401`
  - `ErrUnauthorized`
  - 凭据缺失或无效。
  - 检查 API Key。
* - `403`
  - `ErrPermissionDenied`
  - 当前身份没有目标资源的权限。
  - 使用有权限的凭据，或联系管理员授权。
* - `404`
  - `ErrNotFound`
  - 目标资源不存在，或当前工作区不可见。
  - 检查资源标识和工作区。
* - `500`
  - `ErrServer`
  - 服务端无法完成请求。
  - 记录请求时间和错误信息后重试。
```