Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying the Check Parameters of a Rule Set (Version 3)
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Check Parameters of a Rule Set (Version 3)

Function

This API is used to query check parameters of a task rule set by project ID, task ID, rule set ID, and rule set language. The check tool ID, compilation parameter name, and check parameter configuration information are returned. Pagination query is supported.

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:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition :

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

Constraints:

N/A

Value range:

32-character project ID.

Default value:

N/A

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

ruleset_id

Yes

String

Definition :

Rule set ID. Obtain the ID by calling the API used to obtain the rule set list.

Constraints:

N/A

Value range:

1 to 32 characters.

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

language

Yes

String

Definition:

Rule set language.

Constraints:

N/A

Value range:

  • ArkTS

  • C#

  • Cangjie

  • C++

  • CSS

  • Go

  • HTML

  • Java

  • JavaScript

  • Kotlin

  • Lua

  • PHP

  • Python

  • Rust

  • Scala

  • Shell

  • SQL

  • Terraform

  • TypeScript

Default value:

N/A

offset

No

Integer

Definition:

Offset.

Constraints:

N/A

Value range:

≥0

limit

No

Integer

Definition:

Number of records displayed on each page.

Constraints:

N/A

Value range:

1-1000

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

Array of TaskCheckParameters objects

Definition:

Historical data.

total

Integer

Definition:

Total number.

Value range:

≥0
Table 5 TaskCheckParameters

Parameter

Type

Description

check_id

Integer

Definition:

ID of check tool.

Value range:

≥0

name

String

Definition:

Compilation parameter name.

Value range:

N/A

checker_configs

Array of CheckConfigInfo objects

Definition:

Configuration of the check parameter.
Table 6 CheckConfigInfo

Parameter

Type

Description

name

String

Definition:

Name of the check parameter.

Value range:

N/A

cfg_key

String

Definition:

Key value corresponding to the check parameter.

Value range:

N/A

default_value

String

Definition:

Default value of the check parameter.

Value range:

N/A

option_value

String

Definition:

Options for the check parameter.

Value range:

N/A

is_required

Integer

Definition:

Whether a parameter is mandatory.

Value range:

  • 0: optional.

  • 1: mandatory.

description

String

Definition:

Description for the check parameter.

Value range:

N/A

type

Integer

Definition:

Parameter type.

Value range:

  • 0: text.

  • 2: The optional items exist.

status

String

Definition:

Parameter status.

Value range:

  • on: enabled.

  • off: disabled.

value

String

Definition:

Check parameter value.

Value range:

N/A

Status code: 400

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

GET https://{endpoint}/v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters

Example Responses

Status code: 200

Request succeeded!

{
  "total" : 1,
  "data" : [ {
    "check_id" : 0,
    "name" : "compile_tool",
    "checker_configs" : [ {
      "value" : "",
      "name" : "Compilation Command",
      "cfg_key" : "",
      "default_value" : "",
      "option_value" : "",
      "is_required" : 0,
      "description" : "Compilation command.",
      "type" : 0,
      "status" : "on"
    } ]
  } ]
}

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