# 下载表数据

请求表数据的下载结果。

```text
POST https://moi.matrixorigin.cn/newmoi/catalog/table/download_data
```

## 调用前准备

先[查询数据库中的对象](list-database-objects.md)取得目标表 ID，或准备表名与数据库定位参数。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和表定位信息。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$TABLE_ID`：要下载数据的表 ID。

## 请求体

表的定位方式与[查询表信息](get-table.md)一致：传入 `id`，或传入 `name` 和 `database_id`/`database_name`。

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `id` | integer | 条件必填 | 表 ID。提供后可不传名称。 |
| `name` | string | 条件必填 | 表名；未提供 `id` 时必填。 |
| `database_id` | integer | 条件必填 | 非系统数据库 ID；与 `database_name` 互斥。 |
| `database_name` | string | 条件必填 | 系统数据库名称；与 `database_id` 互斥。 |
| `page` | integer | 否 | 页码；仅用于与表数据查询保持相同的请求形状。 |
| `page_size` | integer | 否 | 每页条数；仅用于与表数据查询保持相同的请求形状。 |
| `preview_lines` | integer | 否 | 预览行数；仅用于与表数据查询保持相同的请求形状。 |
| `include_total` | boolean | 否 | 是否请求总行数；仅用于与表数据查询保持相同的请求形状。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/table/download_data" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$TABLE_ID"'
  }'
```

## 成功响应

成功时返回 `200` 和下载 URL。响应中的 URL 为空字符串时，表示没有可用下载地址，不能据此发起下载。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "url": ""
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.url` | string | 表数据下载地址；为空字符串时没有可用下载地址。 |

## 错误响应

```json
{
  "code": "ErrParamInvalid",
  "msg": "表定位参数无效",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 表 ID、名称定位或分页参数无效。
  - 使用表 ID，或补全表名和数据库定位参数。
* - `403`
  - `ErrForbidden`
  - 当前身份没有表读取权限。
  - 检查工作区和表授权。
* - `409`
  - `ErrReadonlySystemDatabase`
  - 系统数据库不支持当前读取路径。
  - 改用支持的表定位方式。
* - `500`
  - `ErrServer`
  - 服务无法生成下载结果。
  - 记录请求时间和错误信息后重试；持续失败时联系支持人员。
```

## 后续操作

下载完成后如需继续管理，返回[查询 Catalog 详情](get-catalog.md)。