Clear the folder¶

Clear the contents of the specified folder and its subfolders. This operation will delete files and subfolders. Please confirm the target folder before executing.

HTTP
POST $CLOUDSIGMA_API_BASE/catalog/folder/clean

Before you call this API¶

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

First query the file list to obtain the target folder ID.

Set the operation-specific values used in the request:

$FOLDER_ID: ID of the folder to be cleared.

The caller needs write access to the root volume.

Request¶

Input examples

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

Parameter reference

Request body

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

Successful response¶

Returns 200 on success, data is null. The caller needs write access to the root volume.

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": "ErrReadonly",
  "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 folder ID.
`403`	`ErrForbidden`	The current identity does not have write permissions to the root volume.	Use credentials with write access, or contact your administrator for authorization.
`409`	`ErrReadonly`	The database where the folder is located is not writable.	Select a folder in a writable volume.
`500`	`ErrServer`	The service cannot clear the folder.	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 current status.

Last updated on Sep 15, 2026