Cancelling a Batch Task
Function
Cancel a batch task whose status is 0 (to be processed) or 1 (processing). After the task is canceled, the task scheduling module ignores its record.
URI
POST /koodrive/ose/v1/cancel
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
Authorization | Yes | String | Definition: Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}. Constraints: N/A Range: N/A Default Value: N/A |
X-Traceid | No | String | Definition: Service trace ID, which contains 58 bits. Constraints: N/A Range: The value contains 58 bits. Default Value: N/A |
language | No | String | Definition: Language code. Constraints: The value must comply with the internationalization specifications. For example, en_us indicates English (United States). Range: The value must comply with the internationalization specifications. Default Value: en-US |
X-User-Id | Yes | String | Definition: User ID on KooDrive, which is used for app authentication. Constraints: N/A Range: N/A Default Value: N/A |
X-Date | Yes | String | Definition: Date, which is used for app authentication. Constraints: The format is yyyyMMDD'T'HHmmss'Z', for example, 20251103T070140Z. Range: The value must be within 15 minutes from the current time and cannot be later than the current time. Default Value: N/A |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
jobId | Yes | String | Definition: Batch job ID. Constraints: N/A Range: N/A Default Value: N/A |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
data | String | Response service information. |
Status code: 400
Parameter | Type | Description |
|---|---|---|
code | String | Response code. |
msg | String | Response description. |
Status code: 401
Parameter | Type | Description |
|---|---|---|
code | String | Response code. |
msg | String | Response description. |
Status code: 500
Parameter | Type | Description |
|---|---|---|
code | String | Response code. |
msg | String | Response description. |
Example Requests
Cancels a batch task.
POST /koodrive/ose/v1/cancel
Authorization:Bearer+10f**************791e9ff
{
"jobId":"1289250105886769024"
} Example Responses
Status code: 200
Basic response. Only the error code and error information are returned.
{
"code" : 0,
"msg" : "OK"
} Status Codes
Status Code | Description |
|---|---|
200 | Basic response. Only the error code and error information are returned. |
400 | Bad Request |
401 | Unauthorized |
500 | Internal Server Error |
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
