Help Center/ CodeArts Check/ API Reference/ APIs/ Rule Management/ Querying Rule Sets - Version 3

Updated on 2026-08-10 GMT+08:00

Querying Rule Sets - Version 3

Function

This API is used to query the rule set list. You can filter rule sets by project ID and language. Compared with the API of version 2, the API of the current version has a limit on the size of pagination parameters. The API of version 2 will be brought offline later.

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::listRuleSets	List	-	-	-	-

URI

GET /v3/{project_id}/rulesets

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition : You can obtain the 32-character UUID by calling the API used to query the project list. Constraints: N/A Value range: 32-character UUID. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
category	No	String	Definition: Rule set category. Constraints: N/A Value range: 0: Query only the system rule sets. 1: Query only the rule sets of the current user. 2: Query only the rule sets of other users. Default value: N/A
offset	No	Integer	Definition: Offset for pagination. Constraints: N/A Value range: 0–999
limit	No	Integer	Definition: Number of records displayed on each page. Constraints: N/A Value range: 0–50
need_selected_status	No	String	Definition: Whether to query the usage status of a rule set. Constraints: N/A Value range: true: Query the usage status of a rule set. false: Do not query the usage status of a rule set. All rule sets are returned as unused.

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 Range The length is the value of [1-100000]. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
info	Array of RulesetItem objects	Definition: Rule set list information.
total	Integer	Definition: Total number of rule sets. Value range: ≥0

**Table 5** RulesetItem
Parameter	Type	Description
template_id	String	Definition: Rule set ID. Value range: 32-character UUID.
language	String	Definition Rule set language. Range The following 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
template_name	String	Definition: Rule set language. Value range: 1 to 128 characters, including letters, digits, periods (.), hyphens (-), and underscores (_).
creator_id	String	Definition: The user_id of the creator. The value is an IAM user ID. Value range: 32-character UUID.
creator_name	String	Definition Creator name. The value is an IAM username. Range IAM username.
template_create_time	String	Definition Creation time. Use the time zone 00:00. Range Time of time zone 00:00.
is_used	String	Definition: Usage status. Value range: 0: idle 1: in use
rule_ids	String	Definition: The ID of a rule in the rule set. Each rule has a unique ID. Value range: List of 32-character UUIDs. Separate multiple UUIDs with commas (,).
is_default	String	Definition: Whether the rule set is the default for the language. Value range: 0: no. 1: yes.
is_devcloud_project_default	String	Definition: Whether the rule set is the default for the language in the project. Value range: 0: no. 1: yes.
is_default_template	String	Definition: Whether the rule set is preconfigured by the system. Value range: 0: no. 1: yes.

Status code: 400

**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

Status code: 401

**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

Example Requests

GET https://{endpoint}/v3/{project_id}/rulesets

Example Responses

Status code: 200

Request succeeded.

{
  "info" : [ {
    "template_id" : "9698e0cb9d2441c3bd8cec5f8641696e",
    "language" : "Java",
    "template_name" : "test1111",
    "creator_id" : "ae161856f2604229ae12056478a7919f",
    "creator_name" : "Mr. Yang",
    "template_create_time" : "2021-10-21T02:14:55Z",
    "is_used" : "0",
    "rule_ids" : "",
    "is_default" : "0",
    "is_default_template" : "1",
    "is_devcloud_project_default" : "0"
  }, {
    "template_id" : "9698e0cb9d2441c3bd8cec5f8641696e",
    "language" : "cpp",
    "template_name" : "test222",
    "creator_id" : "ae161856f2604229ae12056478a7919f",
    "creator_name" : "Mr. Yang",
    "template_create_time" : "2021-10-21T02:14:55Z",
    "is_used" : "1",
    "rule_ids" : "11152,11153,11154,11155",
    "is_default" : "0",
    "is_default_template" : "1",
    "is_devcloud_project_default" : "1"
  } ],
  "total" : 2
}

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: Rule Management

Previous topic: Setting a default rule set for each language in a project.

Next topic: Querying Default Rule Sets of a Project