Clear the table¶

Delete all data in the table but retain the table definition. This operation is irreversible, please confirm the target table.

HTTP
POST $CLOUDSIGMA_API_BASE/catalog/table/truncate

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 target table ID.

Set the operation-specific values used in the request:

$TABLE_ID: Table ID to be cleared.

This operation is irreversible, please confirm the target table.

Request¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/catalog/table/truncate" \
  -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 on success, data is null. The table definition will be retained and the data in the table will be deleted.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": null
}

Field reference

The response fields are as follows.

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data`	null	Fixed to `null` when cleared successfully.

Error response¶

Response example

JSON
{
  "code": "ErrReadonlySystemDatabase",
  "msg": "数据库不可写",
  "data": null
}

Field reference

Common HTTP errors¶

HTTP status code	error code	Common causes	Recommended actions
`400`	`ErrParamInvalid`	`id` is missing or the requested format is invalid.	Pass in a valid table ID.
`403`	`ErrForbidden`	The current identity does not have table write permission.	Use credentials with write access, or contact your administrator for authorization.
`409`	`ErrReadonlySystemDatabase`	The table is located in a read-only system database.	Select a table in a writable database.
`500`	`ErrServer`	The service cannot clear table data.	Record the request time and error message and try again; if it continues to fail, contact support.

Follow-up operations¶

After completion, Query Catalog details confirms the result.

Last updated on Sep 15, 2026