查询建表语句

查看表或视图的创建语句。响应包含对象定义，不包含表中的数据。

POST https://moi.matrixorigin.cn/newmoi/meta/table/ddl

调用前准备

准备个人访问令牌、工作区 ID、数据库名称和对象名称。可先查询数据库中的表确认表或视图名称。

下方示例使用 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$DATABASE 和 $TABLE。

请求体

字段

类型

是否必填

说明

db_name

string

是

表或视图所在的数据库名称。

table_name

string

是

要读取 DDL 的表或视图名称。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/meta/table/ddl" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{\"db_name\":\"$DATABASE\",\"table_name\":\"$TABLE\"}"

成功响应

{"code":200,"data":{"create_sql":"CREATE TABLE orders (id INT PRIMARY KEY)"}}

响应字段如下。

字段

类型

说明

code

integer

成功时为 200。

data.create_sql

string

表的 CREATE TABLE 语句，或视图的 CREATE VIEW 语句。

错误响应

{
  "code": 404,
  "message": "对象不存在"
}

常见 HTTP 错误

HTTP 状态码

常见原因

建议操作

400

请求体无法解析，或缺少 db_name、table_name。

补齐两个非空字段。

401

凭据缺失或无效。

检查 API Key 和工作区请求头。

403

当前访问凭据没有读取该对象定义的权限。

使用具有相应数据库权限的凭据重试。

404

数据库、表或视图不存在。

检查对象名称和数据库名称。

500

读取 DDL 时发生服务端错误。

稍后重试；持续失败时联系支持人员。

503

数据库连接暂时不可用。

稍后重试。

后续操作

返回列表时查看表字段。

最后更新于