# 查询数据看板列表

按条件分页查询当前工作区可见的数据看板。

```text
POST https://moi.matrixorigin.cn/newmoi/data-dashboards/list
```

## 调用前准备

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

下方示例使用：

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


## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `search` | string | 否 | 按名称或说明筛选。 |
| `page_size` | integer | 否 | 每页返回数量。 |
| `page_token` | string | 否 | 下一页令牌。 |
## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/data-dashboards/list" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "search": "销售",
    "page_size": 20
  }'
```

## 成功响应

查询成功时返回分页结果。

```json
{
  "code": 0,
  "data": {
    "items": [
      {
        "ID": "0198ce73-3d20-7c12-9a11-1a2b3c4d5e6f",
        "Name": "销售概览",
        "Description": "按日查看销售数据",
        "CreatedByRoleID": "role-001",
        "CreatedAt": "2026-08-21T07:00:00Z",
        "UpdatedAt": "2026-08-21T07:00:00Z"
      }
    ],
    "total": 1,
    "has_more": false,
    "next_page_token": ""
  }
}
```

响应字段如下。

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `data.items` | array | 数据看板列表。 |
| `data.items[].ID` | string | 数据看板 ID。 |
| `data.items[].Name` | string | 数据看板名称。 |
| `data.items[].Description` | string | 数据看板说明。 |
| `data.items[].CreatedByRoleID` | string | 创建数据看板时使用的角色 ID。 |
| `data.items[].CreatedAt` | string | 创建时间。 |
| `data.items[].UpdatedAt` | string | 更新时间。 |
| `data.total` | integer | 匹配的数据看板总数。 |
| `data.has_more` | boolean | 是否还有下一页。 |
| `data.next_page_token` | string | 下一页令牌；没有下一页时为空字符串。 |

## 错误响应

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

### 常见 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`
  - 数据看板服务或其依赖暂时不可用。
  - 稍后重试。
```