Help Center/ KooDrive/ API Reference/ API/ Batch Task Operations/ Cancelling a Batch Task
Updated on 2024-07-30 GMT+08:00
View PDF
Share

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

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

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}.

X-Traceid

No

String

Message log trace ID. The value contains 58 bits.

language

No

String

Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

jobId

Yes

String

Task ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response description.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response description.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response description.

Status code: 500

Table 6 Response body parameters

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
Parent topic: Batch Task Operations