查询工作区表概览¶
列出当前工作区可读取的已注册表及物理列名。
POST https://api.moi.matrixorigin.cn/v5/table/overview
调用前准备¶
BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。
准备具有普通工作区访问身份的个人访问令牌和工作区 ID。实际表读取还受 actor 与共享读取绑定约束。BASE_URL 包含同环境产品前缀;MOI_KEY 和 WORKSPACE_ID 分别为产品凭据与工作区 ID。示例 ID 和数据均为占位值。
请求体¶
curl --fail-with-body -sS -X POST "$BASE_URL/table/overview" \
-H "X-API-Key: $MOI_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{}'
没有业务请求参数。
不需要业务请求字段。纯文件目录没有注册表时可跳过;应有物理表缺失时请求可失败。
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"tables": [
{
"db_name": "sales",
"table_name": "orders",
"col_names": [
"id",
"amount"
]
}
]
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 OK。 |
|
string |
成功时为 OK。 |
|
object[](对象数组)或 null |
表概览集合;没有结果时可为 null。 |
|
string |
数据库名称。 |
|
string |
表名称。 |
|
string[](字符串数组) |
物理列名。空值可为 null。 |
错误响应¶
{
"code": "ErrWorkspaceRequired",
"msg": "示例错误信息"
}
HTTP |
code |
条件 |
|---|---|---|
400 |
ErrWorkspaceRequired |
缺少唯一非空 X-Workspace-ID。 |
404 |
ErrNotFound |
元数据关联或应有物理表不存在。 |
身份、权限及依赖失败以实际返回的 code、msg 和诊断字段为准。错误文案可随语言变化。
最后更新于