Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Cancelling a Check Task
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Cancelling a Check Task

Function

This API is used to cancel a code check task based on the task ID and execution record ID. If the execution record ID is not passed, the latest version-level task of the current task is canceled.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:execute

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

PUT /v1/tasks/{task_id}/stop

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

1 to 32 characters.

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

job_id

No

String

Definition :

Execution record ID, that is, the unique ID of each version or quality gate scan. Obtain the ID by calling the API used to execute the check task.

Constraints:

N/A

Value range:

1 to 64 characters.

Default value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition :

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints:

N/A

Value range:

1–100,000 characters.

Default value:

N/A

operator

No

String

Definition:

Operator.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

httpStatus

String

Definition:

HTTP response status.

Value range:

  • OK: The request has been successfully processed, and the server returns the requested resource or operation result.

  • ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations).

  • INTERNAL_SERVER_ERROR: internal API exception.

  • BAD_REQUEST: abnormal parameter verification.

result

String

Definition:

Result of canceling a check task. If the API call is successful, it returns "Cancel succeeded".

Range:

Cancel succeeded.

status

String

Definition:

API response status.

Value range:

  • success: successful response.

  • error: response failed.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

Cancel the execution of the code check task whose task ID is 897acf5exxx48a5013cd and execution ID is ffd8exxxxxx8695d39.

PUT https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/stop?job_id=ffd8exxxxxx8695d39

Example Responses

Status code: 200

Request succeeded!

{
  "httpStatus" : "OK",
  "result" : "Execution canceled.",
  "status" : "success"
}

Status code: 400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Task Management