查询指定表的列名¶
查询指定数据库中一张表的列名,供字段选择使用。
POST https://api.moi.matrixorigin.cn/v5/table/columns
调用前准备¶
BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。
取得数据库 ID 和表名,或取得该数据库下的表 ID。准备可访问工作区并可读取目标表的个人访问令牌和工作区 ID。BASE_URL 包含同环境产品前缀;MOI_KEY 和 WORKSPACE_ID 分别为产品凭据与工作区 ID。示例 ID 和数据均为占位值。
请求体¶
curl --fail-with-body -sS -X POST "$BASE_URL/table/columns" \
-H "X-API-Key: $MOI_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{"database_id": 10, "table_name": "orders"}'
按表 ID 读取时,省略 table_name。
curl --fail-with-body -sS -X POST "$BASE_URL/table/columns" \
-H "X-API-Key: $MOI_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{"database_id":10,"table_id":31}'
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
正整数数据库 ID。 |
|
string |
条件必填 |
非空时按名称查找,并优先于 table_id。 |
|
integer |
条件必填 |
table_name 为空时填写正整数表 ID;必须属于 database_id。 |
只返回列名,不返回列类型或建表语句。按 ID 查询时校验数据库归属。
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"db_name": "sales",
"table_name": "orders",
"col_names": [
"id",
"amount"
]
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 OK。 |
|
string |
成功时为 OK。 |
|
string |
数据库名称。 |
|
string |
实际查询的表名称。 |
|
string[](字符串数组) |
列名;无列时可为 null。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "示例错误信息"
}
HTTP |
code |
条件 |
|---|---|---|
400 |
ErrParamInvalid |
数据库 ID 或表定位无效。 |
404 |
ErrNotFound |
表不存在、ID 不属于指定数据库或物理表未找到。 |
身份、权限及依赖失败以实际返回的 code、msg 和诊断字段为准。错误文案可随语言变化。
最后更新于