下载表数据¶

请求表数据的下载结果。

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

调用前准备¶

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

请求体¶

请求示例

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"'
  }'

参数说明

表的定位方式与查询表信息一致：传入 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	否	是否请求总行数；仅用于与表数据查询保持相同的请求形状。

成功响应¶

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

响应示例

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

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。

下载信息

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

字段	类型	说明
`url`	string	表数据下载地址；为空字符串时没有可用下载地址。

错误响应¶

响应示例

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

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误信息。
`data`	null	错误响应中的附加数据；本示例为 `null`。

后续操作¶

下载完成后如需继续管理，返回查询 Catalog 详情。

最后更新于 2026 年 9 月 3 日