查询指定数据库的表概览

列出指定数据库中可读取的已注册表及列名。

POST https://api.moi.matrixorigin.cn/v5/table/database/tables

调用前准备

BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。

取得目标数据库 ID。准备可访问工作区并可读取目标表的个人访问令牌和工作区 ID。BASE_URL 包含同环境产品前缀;MOI_KEY 和 WORKSPACE_ID 分别为产品凭据与工作区 ID。示例 ID 和数据均为占位值。

请求体

curl --fail-with-body -sS -X POST "$BASE_URL/table/database/tables" \
  -H "X-API-Key: $MOI_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{"database_id": 10}'

字段

类型

是否必填

说明

database_id

integer

是

正整数数据库 ID。

已注册表缺少物理结构时仍可返回该表,col_names 为空数组;它与整个工作区概览的缺表处理不同。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "tables": [
      {
        "db_name": "sales",
        "table_name": "orders",
        "col_names": [
          "id",
          "amount"
        ]
      }
    ]
  }
}

字段

类型

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data.tables

object[](对象数组)或 null

数据库内的表概览;没有结果时可为 null。

data.tables[].db_name

string

数据库名称。

data.tables[].table_name

string

已注册表名称。

data.tables[].col_names

string[](字符串数组)

列名;缺少物理结构时为空数组,物理列集合也可为 null。

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "示例错误信息"
}

HTTP

code

条件

400

ErrParamInvalid

数据库 ID 无效。

404

ErrNotFound

数据库不存在。

身份、权限及依赖失败以实际返回的 code、msg 和诊断字段为准。错误文案可随语言变化。

最后更新于