Get workspace table overviews

List readable registered tables and physical column names in the current workspace.

POST https://api.moi.matrixorigin.cn/v5/table/overview

Before you call this API

BASE_URL uses the product API prefix https://api.moi.matrixorigin.cn/v5. For a dedicated deployment, use its corresponding product API address.

Prepare a personal access token with regular workspace access and a workspace ID. Actual table reads also follow actor/shared-read binding constraints. BASE_URL includes the same environment’s product prefix. MOI_KEY and WORKSPACE_ID are product credentials and workspace ID. Example IDs/data are placeholders.

Request body

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

No business request parameters.

No business request fields are needed. File-only directories without registered tables may be skipped; a missing expected physical table may fail the request.

Successful response

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

Field

Type

Description

code

string

OK on success.

msg

string

OK on success.

data.tables

object[] (array of objects) or null

Table overview collection; may be null without results.

data.tables[].db_name

string

Database name.

data.tables[].table_name

string

Table name.

data.tables[].col_names

string[] (array of strings)

Physical column names; empty values may be null.

Error response

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

HTTP

code

Condition

400

ErrWorkspaceRequired

Missing exactly one nonempty X-Workspace-ID.

404

ErrNotFound

Metadata association or expected physical table missing.

Use actual returned code, msg, and diagnostic fields for identity, permission, and dependency failures. Error text may vary by language.

Last updated on