Batch query table information

Batch query table definitions and metadata by table ID.

HTTP
POST $CLOUDSIGMA_API_BASE/catalog/table/multi_info

Before you call this API

Configure the regional API endpoint and authentication, and select the target workspace.

First query the object in the database to obtain the table ID.

Set the operation-specific values used in the request:

  • $TABLE_ID: The table ID to be queried.

Request

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/catalog/table/multi_info" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ['"$TABLE_ID"']
  }'

Request body

Parameter

Type

Required

Description

ids

integer[]

Yes

List of table IDs to query.

[] after a type means an array. For example, integer[] is an array of integers.

Successful response

On success, 200 and information about each table are returned.

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "tables": [
      {
        "name": "orders",
        "columns": [],
        "create_sql": "CREATE TABLE orders (...)"
      }
    ]
  }
}

The response fields are as follows.

Field

Type

Description

data.tables

array

Queryed table information.

data.tables[].name

string

Table name.

data.tables[].lines

integer

Number of table rows.

data.tables[].size

integer

Table size.

data.tables[].columns

array

Column definition.

data.tables[].create_sql

string

Create table SQL.

data.tables[].stats

array

Column statistics.

Error response

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

Common HTTP errors

HTTP status code

error code

Common causes

Recommended actions

400

ErrParamInvalid

Invalid table ID list.

Check ids.

403

ErrForbidden

The current identity does not have permission to read some or all of the tables.

Use credentials with read permissions.

500

ErrServer

The server failed to read table information.

Try again later.
Last updated on