搜索看板可选数据表¶
按关键词分页搜索当前权限范围内可供看板选择的内部 MatrixOne 表。订阅数据库不进入该搜索结果。
POST https://api.moi.matrixorigin.cn/v5/catalog/data-dashboard/table-search
调用前准备¶
BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。
准备可访问目标工作区且具有表查询权限的个人访问令牌和工作区 ID。BASE_URL 包含同环境产品前缀;MOI_KEY 和 WORKSPACE_ID 分别为产品凭据与工作区 ID。示例 ID 和数据均为占位值。
请求体¶
curl --fail-with-body -sS -X POST "$BASE_URL/catalog/data-dashboard/table-search" \
-H "X-API-Key: $MOI_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{"search": "orders", "page_size": 50}'
下一页保留原搜索条件,将 NEXT_PAGE_TOKEN 设为上次实际返回值。
curl --fail-with-body -sS -X POST "$BASE_URL/catalog/data-dashboard/table-search" \
-H "X-API-Key: $MOI_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{"search":"orders","page_size":50,"page_token":"'"$NEXT_PAGE_TOKEN"'"}'
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
否 |
按空白分隔关键词;省略时不限制关键词。 |
|
integer |
否 |
每页条数。小于等于 0 时取 50,大于 100 时取 100。 |
|
string |
否 |
上次返回的 next_page_token;首次省略。 |
多个关键词分别匹配目录名、数据库名、表名、描述或列信息,所有关键词均须命中。page_token 是规范非负十进制偏移值。保持搜索条件不变,使用返回 token 继续;next_page_token 为空时停止。
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"items": [
{
"table_id": 31,
"table_name": "orders",
"database_id": 10,
"database_name": "sales",
"catalog_id": 1,
"catalog_name": "Default",
"description": "订单",
"matched_fields": [
"table_name"
],
"matched_columns": [],
"metadata_match": true
}
],
"total": 1,
"next_page_token": ""
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 OK。 |
|
string |
成功时为 OK。 |
|
object[](对象数组) |
当前页可选表。 |
|
integer |
本次搜索在当前权限范围内匹配的总数。 |
|
string |
下一页偏移;空字符串表示没有下一页。 |
|
integer |
表 ID。 |
|
string |
表名称。 |
|
integer |
数据库 ID。 |
|
string |
数据库名称。 |
|
integer |
Catalog ID。 |
|
string |
Catalog 名称。 |
|
string |
表描述。 |
|
string[](字符串数组) |
命中的字段名;columns 表示命中列信息。 |
|
string[](字符串数组) |
命中的列名。 |
|
boolean |
是否满足元数据关键词条件。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "示例错误信息"
}
HTTP |
code |
条件 |
|---|---|---|
400 |
ErrParamInvalid |
分页 token 格式无效。 |
503 |
ErrServiceUnavailable |
授权依赖不可用,不能按无匹配结果处理。 |
身份、权限及依赖失败以实际返回的 code、msg 和诊断字段为准。错误文案可随语言变化。