# 查询规则集列表 - ListRulesets #### 功能介绍 该API用于查询规则集列表。支持根据项目ID、语言等条件筛选查询。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck::listRuleSets | List | - | - | - | - | #### URI GET /v2/{project_id}/rulesets 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目的32位UUID，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]的字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | category | 否 | String | **参数解释:** 规则集类别。 **约束限制:** 不涉及。 **取值范围:** - 0：只查询系统规则集。 - 1：只查询当前用户自定义规则集。 - 2：只查询其他用户自定义规则集。 **默认取值:** 不涉及。默认查询所有类别的规则集。 | | offset | 否 | Integer | **参数解释:** 分页索引，偏移量。 **约束限制:** 不涉及。 **取值范围:** 0-999 **默认取值：** 0 | | limit | 否 | Integer | **参数解释:** 分页查询，每页显示的数量。 **约束限制:** 不涉及。 **取值范围:** 0-100 **默认取值：** 100 | | need_selected_status | 否 | String | **参数解释:** 是否查询规则集使用状态。 **约束限制:** 不涉及。 **取值范围:** - true：查询规则集使用状态。 - false：不查询规则集使用状态，规则集使用状态全部返回为未使用状态。 **默认取值：** true | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | info | Array of [RulesetItem] objects | **参数解释:** 规则集列表信息。 | | total | Integer | **参数解释:** 规则集总数。 **取值范围:** ≥0 | 表5RulesetItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | template_id | String | **参数解释:** 规则集ID。 **取值范围:** 32位UUID。 | | language | String | **参数解释:** 规则集语言。 **取值范围:** 当前支持的语言有： - 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 | **参数解释:** 规则集语言。 **取值范围:** 任意中英文，数字，点，连字符-及下划线_。长度为\[1\~128\]个字符。 | | creator_id | String | **参数解释:** 创建者的user_id，值来源于IAM的用户ID。 **取值范围:** 32位UUID。 | | creator_name | String | **参数解释:** 创建人名称，值来源于IAM用户名称。 **取值范围:** IAM用户名称。 | | template_create_time | String | **参数解释:** 创建时间，时区统一为0时区。 **取值范围:** 0时区时间。 | | is_used | String | **参数解释:** 使用状态。 **取值范围:** - 0：空闲中。 - 1：使用中。 | | rule_ids | String | **参数解释:** 规则集包含的规则ID，每条规则都有唯一的规则ID。 **取值范围:** 32位UUID列表，多个UUID以英文逗号分隔。 | | is_default | String | **参数解释:** 规则集是否是该语言默认规则集。 **取值范围:** - 0：不是。 - 1：是。 | | is_devcloud_project_default | String | **参数解释:** 规则集是否是项目下该语言默认规则集。 **取值范围:** - 0：不是。 - 1：是。 | | is_default_template | String | **参数解释:** 规则集是否是系统规则集。 **取值范围:** - 0：不是。 - 1：是。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v2/{project_id}/rulesets ``` #### 响应示例 **状态码：200** 请求成功! ``` { "info" : [ { "template_id" : "9698e0cb9d2441c3bd8cec5f8641696e", "language" : "Java", "template_name" : "test1111", "creator_id" : "ae161856f2604229ae12056478a7919f", "creator_name" : "杨老板", "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" : "杨老板", "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 } ``` **状态码：400** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功! | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。