CLI Command Reference

Creating a Check Task

hcloud CodeArtsCheck CreateTask

Create a check task but do not execute it.

Go debug

Deleting a Check Task

hcloud CodeArtsCheck DeleteTask

This interface is used to delete a check task. A task that is being executed cannot be viewed.

Go debug

Querying the task list

hcloud CodeArtsCheck ShowTaskListByProjectId

Query the task list of the project based on DEVCLOUD_PROJECT_UUID.

Go debug

Executing a Check Task

hcloud CodeArtsCheck RunTask

Execute the check task.

Go debug

Stopping a Check Task

hcloud CodeArtsCheck StopTaskById

This interface is used to terminate a check task based on the task ID.

Go debug

Querying the Task Execution Status

hcloud CodeArtsCheck ShowProgressDetail

Query the task execution status based on the task ID. Task status: 0 indicates that the task is being checked, 1 indicates that the check fails, 2 indicates that the check is successful, and 3 indicates that the task is stopped. The detailed progress information is displayed only when the check is in progress.

Go debug

Querying Historical Scan Results

hcloud CodeArtsCheck CheckRecord

Provides statistics on the number of issues scanned each time.

Go debug

Querying the Selected Rule Sets of a Task

hcloud CodeArtsCheck ListTaskRuleset

List of selected rule sets of a query task.

Go debug

Querying the Selected Rule Sets of a Task

hcloud CodeArtsCheck ShowTasksRulesets

List of selected rule sets of a query task.

Go debug

Querying the Check Parameters of a Task Rule Set

hcloud CodeArtsCheck CheckParameters

Querying the Check Parameters of a Task Rule Set

Go debug

Querying the Check Parameters of a Task Rule Set

hcloud CodeArtsCheck CheckRulesetParameters

Querying the Check Parameters of a Task Rule Set

Go debug

Task Configuration Check Parameters

hcloud CodeArtsCheck ListTaskParameter

Task Configuration Check Parameters

Go debug

Modifying a Task Rule Set

hcloud CodeArtsCheck UpdateTaskRuleset

Modify a task rule set.

Go debug

Querying Task Check Failure Logs

hcloud CodeArtsCheck ShowTasklog

This interface is used to query task check failure logs. If execute_id is not transferred, the latest check log is queried.

Go debug

Obtaining the Directory Tree of a Task

hcloud CodeArtsCheck ShowTaskPathTree

Obtains the directory tree of a task.

Go debug

Shielding a Directory in Task Configuration

hcloud CodeArtsCheck UpdateIgnorePath

Shielded directory for task configuration.

Go debug

Querying Advanced Settings of a Task

hcloud CodeArtsCheck ShowTaskSettings

Advanced settings of a query task.

Go debug

Configuring Advanced Settings for a Task

hcloud CodeArtsCheck UpdateTaskSettings

Configures advanced settings for a task, such as custom image.

Go debug

Query Defect Summary

hcloud CodeArtsCheck ShowTaskDetail

Query the summary of the defect result based on the check task ID. Including the problem overview, problem status, cyclomatic complexity, and code repetition rate.

Go debug

Querying the cmertrics Defect Summary

hcloud CodeArtsCheck ShowTaskCmetrics

Query the cmertrics defect summary based on the check task ID.

Go debug

Querying Defect Details

hcloud CodeArtsCheck ShowTaskDefects

This API is used to query defect result details by check task ID in pagination mode.

Go debug

Querying Defect Details Statistics

hcloud CodeArtsCheck ShowTaskDefectsStatistic

This interface is used to query defect details based on the check task ID.

Go debug

Modify Defect Status

hcloud CodeArtsCheck UpdateDefectStatus

Change the status of detected defects to Resolved or Ignored.

Go debug

Interface for Obtaining the Rule List

hcloud CodeArtsCheck ListRules

This API queries the rule list based on conditions such as the language and problem level.

Go debug

Creating a User-Defined Rule Set

hcloud CodeArtsCheck CreateRuleset

Rules can be flexibly combined as required.

Go debug

Querying the Rule Set List

hcloud CodeArtsCheck ListRulesets

This API is used to query the rule set list based on conditions such as the project ID and language.

Go debug

Viewing the Rule List of a Rule Set

hcloud CodeArtsCheck ListTemplateRules

This API is used to query the rule list based on conditions such as the project ID and rule set ID.

Go debug

Deleting a User-Defined Rule Set

hcloud CodeArtsCheck DeleteRuleset

This interface is used to delete a user-defined rule set. The rule set in use or the default rule set cannot be deleted.

Go debug

Set the default rule set configuration for the language corresponding to each project.

hcloud CodeArtsCheck SetDefaulTemplate

Set the default rule set configuration for the language corresponding to each project.

Go debug