Unmounts all tables from a specified category folder.
Operation description
Unmounts all tables mounted under a specified category folder. The folder structure remains unchanged. The folder level is not limited (L1 to L4 are all supported). The operation recursively covers all descendant folders starting from the specified folder as the root. Only the mount relationships between tables and folders are removed. No folders are deleted. If DryRun is set to true, only the affected statistics are returned without actual cleanup.
Try it now
Test
RAM authorization
Request syntax
POST / HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| CategoryId |
integer |
Yes |
The ID of the category folder to clean up. The folder level is not limited. Only the mount relationships of all tables under the folder (including all descendant folders) are removed. The folder itself and its hierarchy remain unchanged. If the folder does not exist, 404 is returned. |
20 |
| DryRun |
boolean |
No |
Specifies whether to perform a dry run. If set to true, only the number of mount relationships and tables that would be cleaned up is returned without actual deletion. Default value: false. |
false |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response body. |
||
| RequestId |
string |
Id of the request |
0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931 |
| ErrorCode |
string |
The error code. |
UnknownError |
| ErrorMessage |
string |
The error message. |
UnknownError |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
| Data |
object |
The cleanup result. |
|
| CategoryId |
integer |
The ID of the category folder that was cleaned up. |
FC-0F46B2A2E4FA22AF |
| CategoryName |
string |
The name of the category folder that was cleaned up. |
xxx |
| ScannedCategoryCount |
integer |
The number of folders scanned during this operation, including the specified folder itself and all its descendant folders. |
1 |
| ClearedRelationCount |
integer |
The number of mount relationships that were removed. If DryRun is set to true, this value indicates the number of mount relationships that would be removed. |
1 |
| ClearedTableCount |
integer |
The number of distinct tables affected after deduplication. |
1 |
| ClearedTableIds |
array |
Sample IDs of the affected tables. A maximum of 200 IDs are returned. |
|
|
integer |
The table ID. |
1 |
|
| DryRun |
boolean |
Indicates whether the operation was performed in dry run mode. |
True |
Examples
Success response
JSON format
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true,
"Data": {
"CategoryId": 0,
"CategoryName": "xxx",
"ScannedCategoryCount": 1,
"ClearedRelationCount": 1,
"ClearedTableCount": 1,
"ClearedTableIds": [
1
],
"DryRun": true
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.