查看 SQL 工作簿列表

列出当前工作区可访问的 SQL 工作簿。每项中的工作簿 ID 可用于查看版本、修改名称或删除工作簿。

POST https://api.moi.matrixorigin.cn/v5/workbook/list

调用前准备

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

请求体

将示例中的调用者专属值替换为实际值。

curl -X POST "https://api.moi.matrixorigin.cn/v5/workbook/list" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "page_size": 20
  }'

参数

类型

是否必填

说明

search

string

否

按名称搜索。

page_size

integer

否

每页数量，范围 1 至 100；不传时为 20。

page_token

string

否

下一页标记。

成功响应

响应返回 SQL 工作簿列表和匹配总数。记录所选项的工作簿 ID 后，可继续查看版本、修改名称或删除工作簿。

{
  "code": 200,
  "data": {
    "total": 21,
    "result": [
      {
        "workbook_id": "workbook-123",
        "name": "销售分析"
      }
    ],
    "next_page_token": "eyJvZmZzZXQiOjIwfQ"
  }
}

字段

类型

说明

code

integer

成功时为 200。

data

object

SQL 工作簿列表。

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

字段

类型

说明

total

integer

当前查询匹配的记录总数。

result

array of object

SQL 工作簿列表。

next_page_token

string

下一页标记；为空时没有下一页。

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

字段

类型

说明

workbook_id

string

SQL 工作簿的 ID。

name

string

SQL 工作簿名称。

读取下一页

每页最多返回 100 条工作簿；未传 page_size 时返回 20 条。读取下一页时，将响应中的 next_page_token 原样写入下一次请求的 page_token。该值为空时，表示没有下一页。

错误响应

{
  "code": 400,
  "message": "请求参数无效"
}

字段

类型

说明

code

integer 或 string

错误代码或状态码。

message

string

错误信息。

后续操作

选择工作簿后，查看 SQL 工作簿版本列表、更新 SQL 工作簿名称或删除 SQL 工作簿。

最后更新于