批量查询表信息

按表 ID 批量查询表定义和元数据。

POST https://api.moi.matrixorigin.cn/v5/catalog/table/multi_info

调用前准备

先查询数据库中的对象取得表 ID。准备可访问目标工作区的个人访问令牌、目标工作区 ID 和表 ID 列表。

请求体

curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/table/multi_info" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ['"$TABLE_ID"']
  }'

字段

类型

是否必填

说明

ids

integer（整数数组）

是

要查询的表 ID 列表。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "tables": [
      {
        "name": "orders",
        "created_at": 0,
        "updated_at": 0,
        "created_by": "",
        "description": "",
        "comment": "",
        "columns": [],
        "create_sql": "CREATE TABLE orders (...)",
        "stats": []
      }
    ]
  }
}

字段

类型

说明

code

string

请求处理成功时为 OK。

msg

string

请求处理的说明文本。

data

object

响应数据。

data.tables

object（对象数组）

查询到的表信息。

data.tables[].name

string

表名称。

data.tables[].lines

integer

表行数。未设置时可省略。

data.tables[].size

integer

表大小。未设置时可省略。

data.tables[].created_at

integer

创建时间，采用 RFC 3339 格式。

data.tables[].updated_at

integer

最近更新时间，采用 RFC 3339 格式。

data.tables[].created_by

string

创建者标识。

data.tables[].description

string

说明。

data.tables[].comment

string

注释。

data.tables[].columns

object（对象数组）

列定义。

data.tables[].columns[].name

string

列名称。

data.tables[].columns[].type

string

列的数据类型。

data.tables[].columns[].is_pk

boolean

是否为主键列。有值时返回。未设置时可省略。

data.tables[].columns[].comment

string

列注释。有值时返回。未设置时可省略。

data.tables[].columns[].default

string

列默认值。有值时返回。未设置时可省略。

data.tables[].create_sql

string

建表 SQL。

data.tables[].stats

object（对象数组）

列统计信息。

data.tables[].stats[].name

string

列名称。

data.tables[].stats[].type

string

列的数据类型。

data.tables[].stats[].is_pk

boolean

是否为主键列。有值时返回。未设置时可省略。

data.tables[].stats[].default

string

列默认值。有值时返回。未设置时可省略。

data.tables[].stats[].comment

string

列注释。有值时返回。未设置时可省略。

data.tables[].stats[].max_value

string

列的最大值。

data.tables[].stats[].min_value

string

列的最小值。

错误响应

{
  "code": "ErrServer",
  "msg": "服务器内部错误"
}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。
最后更新于