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

Executing a Check Task

Function

This API is used to perform a version-level scan on the repository and branch of the task based on the task ID.

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

POST /v2/tasks/{task_id}/run

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, which is the return value of the API used to create a check task. Each check task, its brach tasks, and incremental tasks created through APIs have a unique task ID. Obtain the ID by calling the API used to query the task list. id indicates the task ID.

Constraints:

N/A.

Value range:

1 to 32 characters.

Default value:

N/A.

Request Parameters

Table 2 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

Range

The length is the value of [1-100000].

Default Value

N/A

Content-Type

Yes

String

Definition:

Media type and encoding format.

Constraints:

N/A.

Value range:

N/A.

Default value:

application/json;charset=UTF-8
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

username

No

String

Definition:

This parameter is deprecated.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

access_token

No

String

Definition:

This parameter is deprecated.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

git_url

No

String

Definition:

This parameter is deprecated.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

git_branch

No

String

Definition:

This parameter is deprecated.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

ref

No

String

Definition:

The method of pulling MR code from a repository. Set this parameter if MR code fails to be pulled in the check stage.

Constraints:

N/A

Value range:

  • pull: Pull code using pull/xx/xx.

  • merge_request: Pull code using merge_request/xx/xx.

  • Gitee repository: Pull code using pull/xx/xx.

  • Non-Gitee repository: Pull code using merge_request/xx/xx.

Default value:

The system automatically identifies the code repository type to pull the MR code.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

exec_id

String

Definition:

Execution record ID of a check task.

Value range:

32-character UUID.

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

Execute a check task. Pass the ref parameter if you want to specify the incremental code downloading mode.

POST https://{endpoint}/v2/tasks/{task_id}/run

{
  "ref" : "merge_request"
}

Example Responses

Status code: 200

Request succeeded.

{
  "exec_id" : "d163535d0*******81d6a7654443e"
}

Status code: 400

A request error occurred.

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

Status code: 401

The permission is insufficient.

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

Status Codes

Status Code

Description

200

Request succeeded.

400

A request error occurred.

401

The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management