Query table full path¶

The full path of the query table in the catalog hierarchy.

HTTP
POST $CLOUDSIGMA_API_BASE/catalog/table/full_path

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¶

Input examples

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

Parameter reference

Request body

Parameter	Type	Required	Description
`id`	integer	Yes	Table ID.

Successful response¶

Returns 200 and the full path on success.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "path": "catalog-a/database-a/orders"
  }
}

Field reference

The response fields are as follows.

Field	Type	Description
`data.path`	string	The full path to the table in the Catalog hierarchy.

Error response¶

Response example

JSON
{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

Field reference

Common HTTP errors¶

HTTP status code	error code	Common causes	Recommended actions
`400`	`ErrParamInvalid`	The table ID is invalid.	Use a valid table ID.
`403`	`ErrForbidden`	The current identity does not have permission to read the table.	Use credentials with read permissions.
`500`	`ErrServer`	The server failed to resolve the table path.	Try again later.

Last updated on Sep 15, 2026