Deleting an Asynchronous Task of a File System
Function
This API is used to delete an asynchronous task. If the task is being executed, the task will be cancelled and then deleted. Only tasks for querying the directory usage can be deleted. Such tasks are also referred to as DU tasks. The value of feature in the API request path is dir-usage.
Constraints
This API is only supported for file systems created after August 1, 2023. The value of feature in the API request path can only be the following:
-
dir-usage
This API is only supported for the following types of file systems:
-
20 MB/s/TiB
-
40 MB/s/TiB
-
125 MB/s/TiB
-
250 MB/s/TiB
-
500 MB/s/TiB
-
1,000 MB/s/TiB
For SFS Turbo Standard, Standard-Enhanced, Performance, Performance-Enhanced file systems, use the API for querying the file system directory usage.
URI
DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks/{task_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
The project ID. |
share_id |
Yes |
String |
The file system ID. |
feature |
Yes |
String |
The task type. For example, the value for DU tasks is dir-usage. |
task_id |
Yes |
String |
The task ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
The account token. |
Content-Type |
Yes |
String |
The MIME type, which can be application or json. |
Response Parameters
Status code: 202
Accepted
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
The request ID. |
Parameter |
Type |
Description |
---|---|---|
errCode |
String |
The error code. |
errMsg |
String |
The error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
The request ID. |
Parameter |
Type |
Description |
---|---|---|
errCode |
String |
The error code. |
errMsg |
String |
The error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
The request ID. |
Parameter |
Type |
Description |
---|---|---|
errCode |
String |
The error code. |
errMsg |
String |
The error message. |
Example Requests
Deleting the task whose ID is 11abef677ac40f46644d1d5cfc2424a4 for the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde
DELETE HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/fs/dir-usage/tasks/11abef677ac40f46644d1d5cfc2424a4
Example Responses
Status code: 400
Error response
{ "errCode" : "SFS.TURBO.0123", "errMsg" : "feature invalid" }
Status code: 404
Error response
{ "errCode" : "SFS.TURBO.0124", "errMsg" : "task_id not found" }
Status code: 500
Error response
{ "errCode" : "SFS.TURBO.0005", "errMsg" : "Internal server error" }
Status Codes
Status Code |
Description |
---|---|
202 |
Accepted |
400 |
Error response |
404 |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot