下载表 CSV 数据¶
将指定 Catalog 表的查询结果直接下载为带表头的 CSV 文件,最多读取 1,000,000 行。
POST https://api.moi.matrixorigin.cn/v5/catalog/table/download
调用前准备¶
BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。
先取得可查询表的正整数表 ID。准备具有 table.query 权限的个人访问令牌和工作区 ID,并指定本地保存路径。BASE_URL 包含同环境产品前缀;MOI_KEY 和 WORKSPACE_ID 分别为产品凭据与工作区 ID。示例 ID 和数据均为占位值。
OUTPUT_FILE 指向本地保存路径。
请求体¶
curl --fail-with-body -sS -X POST "$BASE_URL/catalog/table/download" \
-H "X-API-Key: $MOI_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{"id": 31}' \
-o "$OUTPUT_FILE"
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
表 ID。 |
接口没有分页、续传或总行数参数。超过行数上限的数据需要另行确认导出方案。
成功响应¶
id,amount
1,12.50
响应项 |
类型 |
说明 |
|---|---|---|
Content-Type |
string |
成功时为 text/csv; charset=utf-8。 |
Content-Disposition |
string |
附件名使用表名称并进行 URL 编码,扩展名为 .csv。 |
响应体 |
bytes(字节流) |
CSV 表头及数据行。读取结束且客户端无错误后,检查实际文件内容。 |
流开始前失败可返回 JSON 业务错误。已有字节后失败会中断连接;收到 HTTP 200 或部分文件不能证明完整下载。
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "示例错误信息"
}
HTTP |
code |
条件 |
|---|---|---|
400 |
ErrParamInvalid |
请求 JSON 无效。 |
409 |
ErrReadonlySystemDatabase |
表 ID 不为正数。 |
404 |
ErrNotFound |
目标表业务读取失败且确认不存在。 |
身份、权限及依赖失败以实际返回的 code、msg 和诊断字段为准。错误文案可随语言变化。
最后更新于