Querying Tasks

codeartscheck:task:list

List

task *

-

-

-

-

codeartscheck:ProjectId

page

No

Integer

Definition:

Page number.

Constraints:

≥ 1.

Value range:

1–2,147,483,647

Default value:

N/A

page_size

No

Integer

Definition:

Page size.

Constraints:

The value ranges from 1 to 200.

Value range:

1–200

Default value:

N/A

search

No

String

Definition:

Name of the task to be searched for.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

No

String

Definition :

32-character project UUID. Obtain it by calling the API used to query the project list.

Constraints:

N/A.

Value range:

1 to 32 characters.

Default value:

N/A.

review_result_types

No

String

Definition:

Gate check result.

Constraints:

N/A

Value range:

• success: The gate is passed.

• error: The gate is not passed.

Default value:

N/A

job_status_types

No

String

Definition:

Check status.

Constraints:

N/A

Value range:

• success: check successful.

• failed: check failed.

• aborted: The check is stopped.

• executing: The task is being executed.

• never_execute: The check has not been performed.

Default value:

N/A

order_by_execute_time

No

String

Definition:

Whether to sort tasks by execution time.

Constraints:

N/A

Value range:

• up: Sort tasks by execution time in ascending order.

• down: Sort tasks by execution time in descending order.

Default value:

N/A

task_classification_id

No

String

Definition:

Group ID of a task. You can obtain the group ID by calling the API for listing group information of a project.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

repo_url

No

String

Definition:

Code repository address.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

branch

No

String

Definition:

Branch.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

repo_url_full_match

No

String

Definition:

This parameter is used together with repo_url to determine whether to completely match repo_url when tasks are queried.

Constraints:

N/A

Value range:

• true: Only the tasks whose code repository address is repo_url are queried.

• false: Query the tasks whose repository address (using either the SSH protocol or the HTTP protocol) matches the repo_url.

Default value:

false

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

Encoding format.

Constraints

N/A

Range

N/A

Default Value

application/json: The return value is in JSON format for any input value.

operator

No

String

Definition:

Operator username.

Constraints:

N/A.

Value range:

1 to 128 characters.

Default value:

N/A.

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

ShowTasksListResult object

Definition

Response body for querying tasks.

status

String

Definition:

API response status.

Value range:

• success: successful response.

• error: response failed.

info

Array of TaskBasicInfo objects

Definition

Task list.

total

Integer

Definition:

Total number of code check tasks.

Range:

N/A

branchName

String

Definition:

Branch name.

Range:

N/A

canDelete

Boolean

Definition

Whether granted the permission for deleting the task.

Range

• true: The delete permission is granted.

• false: The delete permission is not granted.

canEdit

Boolean

Definition:

Whether the user has the edit permission.

Value range:

• true: The edit permission is granted.

• false: The edit permission is not granted.

canExecute

Boolean

Definition:

Whether the user has the execute permission.

Value range:

• true: The execute permission is granted.

• false: The execute permission is not granted.

canRead

Boolean

Definition:

Whether the user has the read permission.

Value range:

• true: The read permission is granted.

• false: The read permission is not granted.

configTemplate

ConfigTemplateBasicInfo object

Definition:

Configuration template details.

configTemplateId

String

Definition:

ID of the task configuration template.

Value range:

1 to 128 characters.

createTime

String

Definition:

Task creation time (UTC). Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z.

Value range:

N/A

id

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.

Value range:

1 to 128 characters.

isFollowed

Boolean

Definition:

Whether a task is favorited.

Value range:

• true: The task is favorited.

• false: The task is not favorited.

jobResult

JobResultInfo object

Definition

Execution result.

lastJob

JobBasicInfo object

Definition

Execution record information.

lastUpdateTime

String

Definition:

Time (UTC) when a task was last updated. Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z.

Value range:

N/A

name

String

Definition:

code check task name.

Range:

N/A

owner

String

Definition:

Owner of a code check task.

Range:

N/A

projectId

String

Definition :

32-character project UUID. Obtain it by calling the API used to query the project list.

Value range:

1 to 32 characters.

projectName

String

Definition:

Project name.

Range:

N/A

region

String

Definition:

Huawei Cloud region.

Range:

N/A

repoUrl

String

Definition:

Code repository address.

Range:

N/A

ruleSets

Array of ConfigTemplateRuleSetInfo objects

Definition

Rule set configuration list.

ruleType

String

Definition:

Task type.

Value range:

• basic: general task.

• security: security enhanced package task.

taskGroupId

String

Definition:

Task group ID.

Value range:

1 to 128 characters.

arch

String

Definition:

Executor type.

Range:

x86 or Arm.

branch

String

Definition:

Branch name.

Range:

N/A

createTime

String

Definition:

Configuration template creation time (UTC). Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z.

Value range:

N/A

creator

String

Definition:

Creator of the configuration template.

Range:

N/A

exclude

String

Definition:

Excluded directories in a task.

Range:

N/A

id

String

Definition:

Configuration template ID. The configuration template ID is required for modifying the configuration information. Each CodeArts Check task and its branch tasks have the same unique configuration template ID.

Value range:

N/A

includePaths

String

Definition:

Checked directory. If you do not specify any directory, all code files in the code repository are checked. If you specify one or more directories, only the files in the specified directories are checked.

Range:

N/A

lastReviser

String

Definition:

Last modifier name.

Range:

N/A

lastUpdateTime

String

Definition:

Time (UTC) when the configuration template was last modified. Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z.

Value range:

N/A

name

String

Definition:

Name of a configuration template.

Range:

N/A

projectId

String

Definition :

32-character project UUID. Obtain it by calling the API used to query the project list.

Value range:

1 to 32 characters.

projectName

String

Definition:

Project name.

Range:

N/A

region

String

Definition:

Huawei Cloud region.

Range:

N/A

repoType

String

Definition:

Code repository type.

Value range:

• DevCloud: CodeArts Repo repository.

• Gitee: Gitee repository.

• GitHub: GitHub repository.

• GitPub: Git repository.

• gitcode: GitCode repository.

• gitlab: GitLab repository.

• self_gitlab: self-built GitLab repository.

• tfs_git: TFS repository.

• bitbucket: Bitbucket repository.

repoUrl

String

Definition:

Code repository address.

Range:

N/A

resourcePoolId

String

Definition:

ID of an enabled agent pool. Leave this parameter as an empty string ("") when using built-in executors.

Value range:

N/A

resourcePoolName

String

Definition:

Name of an enabled agent pool. Leave this parameter blank when using built-in executors.

Range:

N/A

resource_pool_type

String

Definition:

Enabled agent pool type.

Value range:

• default: built-in agent pool.

• exclusive: dedicated agent pool.

• self-hosted: self-hosted agent pool.

reviewData

Array of ReviewDataInfoResponse objects

Definition

Task gate configurations.

reviewDataJson

String

Definition:

JSON characters of the task gate configurations.

Range:

N/A

ruleSets

Array of ConfigTemplateRuleSetInfo objects

Definition

Rule set configuration list.

compareType

String

Definition:

Calculation logic.

Range:

The value is ≤.

isCheck

Integer

Definition

Gate switch.

Range

• 0: disabled.

• 1: enabled.

name

String

Definition:

Gate item.

Range:

Number of critical issues.

Number of major issues.

Number of minor issues.

Number of suggestions.

value

Integer

Definition:

Gate threshold.

Value range:

≥0

executor

String

Definition:

Name of the user who executes the task.

Range:

N/A

finishTime

String

Definition:

Execution completion time (UTC). Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z.

Value range:

N/A

jobResult

JobResultInfo object

Definition

Execution result.

jobType

String

Definition:

Task type.

Value range:

• FULL: version-level task.

• INC_GIT: gate-level task.

- INC_COMMIT: incremental check for the most recent commit in the pipeline, specified by commit ID, under version-level check mode (task settings > check scope > check mode).

- INC_LAST_SUCCESS_COMMIT: incremental check between the commit of a specified commit ID and the commit of the ID of the last successful gate check in the pipeline.

process

ProcessInfo object

Definition

Execution record information.

startTime

String

Definition:

Execution start time (UTC). Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z.

Value range:

N/A

status

String

Definition:

Task execution status.

Range:

• quering: initial state.

• running: task being executed.

• success: check successful.

• failed: check failed.

• aborted: task aborted.

taskId

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.

Value range:

1 to 32 characters.

CRITICAL

Integer

Definition:

Number of major issues.

Value range:

≥0

DELAYSTATUS_COUNT

Integer

Definition:

Number of deferred issues.

Value range:

≥0

FATAL

Integer

Definition:

Number of critical issues.

Value range:

≥0

GENERAL

Integer

Definition:

Number of minor issues.

Value range:

≥0

INFO

Integer

Definition:

Number of information issues.

Value range:

≥0

PROMPT

Integer

Definition:

Number of suggestions.

Value range:

≥0

codeLine

Integer

Definition:

Number of scanned code lines, excluding blank and comment lines.

Value range:

≥0

defectCount

Integer

Definition:

Total bugs.

Value range:

≥0

dismissed

Integer

Definition:

Number of ignored issues.

Value range:

≥0

fileTotal

Integer

Definition:

Total number of files.

Value range:

≥0

fixed

Integer

Definition:

Number of fixed issues.

Value range:

≥0

id

String

Definition:

Execution ID, which is returned by the API of code check task execution. Each code check task has a unique execution ID.

Value range:

N/A

jobId

String

Definition:

Execution ID, which is returned by the API of code check task execution. Each code check task has a unique execution ID.

Value range:

N/A

newUnsolvedDefectCount

Integer

Definition:

Number of new issues that are not resolved.

Value range:

≥0

nonSecurityDefectCount

Integer

Definition:

Number of non-security issues.

Value range:

≥0

reviewResult

String

Definition:

Gate check result.

Range:

• success: The gate is passed.

• error: The gate is not passed.

securityDefectCount

Integer

Definition:

Number of security issues.

Value range:

≥0

solvedDefectCount

Integer

Definition:

Number of resolved issues.

Range:

N/A

unsolvedDefectCount

Integer

Definition:

Number of unresolved issues.

Range:

N/A

exeTime

String

Definition:

Execution time, in seconds.

Range:

N/A

executeTime

String

Definition:

Execution time. The format is %dm%ds, for example, 6m6s.

Value range:

N/A

message

String

Definition:

Execution process.

Range:

N/A

process

String

Definition:

Task execution progress, in percentage.

Range:

N/A

status

String

Definition:

Task execution status.

Range:

• quering: initial state.

• running: task being executed.

• success: check successful.

• failed: check failed.

• aborted: task aborted.

language

String

Definition

Language type.

Range

Custom language or system language. The following system languages are supported:

• ARKTS

• C#

• CANGJIE

• C++

• CSS

• GO

• HTML

• JAVA

• JAVASCRIPT

• KOTLIN

• LUA

• PHP

• PYTHON

• RUST

• SCALA

• SHELL

• SQL

• TERRAFORM

• TYPESCRIPT

• AZURERESOURCEMANAGER

• DOCKER

• KUBERNETES

ruleSetId

String

Definition:

Rule set ID.

Value range:

1 to 32 characters.

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

200

The task list is displayed.

400

A request error occurred.

401

The permission is insufficient.