Deleting a Directory
Function
This API is used to delete a directory.
Constraints
This API is only supported for file systems created after June 1, 2023.
Deleting a directory from a file system is a risky operation. Once deleted, the directory cannot be recovered. Ensure that the directory you specify is one you want to delete.
URI
DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/dir
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
The project ID. |
|
share_id |
Yes |
String |
The file system ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
The account token. |
|
Content-Type |
Yes |
String |
The MIME type. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
path |
Yes |
String |
The valid full path of an existing directory. |
Response Parameters
Status code: 202
Deletion request accepted
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
errCode |
String |
The error code. |
|
errMsg |
String |
The error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
errCode |
String |
The error code. |
|
errMsg |
String |
The error message. |
Example Requests
Deleting the /test directory
{
"path" : "/test"
}
Example Responses
Status code: 500
Error response
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
202 |
Deletion request accepted |
|
400 |
Error response |
|
500 |
Error response |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
