# 查看规则集的规则列表 - ListTemplateRules #### 功能介绍 该API用于查询项目下某一规则集里的规则列表。可按照规则启用状态等条件筛选查询。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck::getRuleSet | Read | - | - | - | - | #### URI GET /v2/{project_id}/ruleset/{ruleset_id}/rules 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目的32位UUID，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]的字符。 **默认取值：** 不涉及。 | | ruleset_id | 是 | String | **参数解释:** 规则集ID，通过[查询规则集列表](https://support.huaweicloud.com/api-codecheck/ListRulesets.html)接口可获取到规则集ID **约束限制:** 不涉及。 **取值范围:** 长度为\[1\~32\]的字符。 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | types | 否 | String | **参数解释:** 规则状态。 **约束限制:** 不涉及。 **取值范围:** - 1：查询全部规则。 - 2：查询已启用规则。 - 3：查询未启用。 **默认取值:** 1 | | languages | 否 | String | **参数解释:** 规则语言。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | | tags | 否 | String | **参数解释:** 规则所属标签。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释:** 分页索引，偏移量。 **约束限制:** 不涉及。 **取值范围:** 0-999 **默认取值：** 0 | | limit | 否 | Integer | **参数解释:** 分页查询，每页显示的数量。 **约束限制:** 不涉及。 **取值范围:** 0-200 **默认取值：** 100 | #### 请求参数 表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 [RuleItem] objects | **参数解释:** 规则集的规则列表信息。 | | total | Integer | **参数解释:** 总数。 **取值范围:** ≥0 | 表5RuleItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | rule_id | String | **参数解释:** 规则ID。 **取值范围:** 32位ID。 | | rule_language | String | **参数解释:** 规则所属语言。 **取值范围:** 当前支持的语言有： - ARKTS - C# - CANGJIE - C++ - CSS - GO - HTML - JAVA - JAVASCRIPT - KOTLIN - LUA - PHP - PYTHON - RUST - SCALA - SHELL - SQL - TERRAFORM - TYPESCRIPT - AZURERESOURCEMANAGER - DOCKER - KUBERNETES | | rule_name | String | **参数解释:** 规则名称。 **取值范围:** 不涉及。 | | rule_severity | String | **参数解释:** 规则问题级别。 **取值范围：** - 0：致命。 - 1：严重。 - 2：一般。 - 3：提示。 | | tags | String | **参数解释:** 规则标签。 **取值范围:** - huawei - iso5055 - cert - cwe - top10 - top25 - misra - GJB - autosar - PCI DSS | | checked | String | **参数解释:** 规则状态。 **取值范围:** - 0：未启用。 - 1：已启用。 | | rule_config_list | Array of [RuleConfigParam] objects | **参数解释:** 规则配置参数阈值相关信息。 | 表6RuleConfigParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释:** 规则配置ID。可调用[获取规则列表接口](https://support.huaweicloud.com/api-codecheck/ListRules.html)获取规则配置ID。 **取值范围:** 32位UUID。 | | rule_id | String | **参数解释:** 工具规则ID，即可配置阈值规则的各种阈值对应的ID，当前无便利手段获取，请联系客服咨询。 **取值范围:** 32位UUID。 | | default_value | String | **参数解释:** 配置参数默认阈值。 **取值范围:** 不涉及。 | | option_value | String | **参数解释:** 配置参数新阈值。 **取值范围:** 不涉及。 | | option_key | String | **参数解释:** 当前规则配置项key。可调用[获取规则列表接口](https://support.huaweicloud.com/api-codecheck/ListRules.html)获取规则配置ID。 **取值范围:** 不涉及。 | | option_name | String | **参数解释:** 当前规则配置项key。可调用[获取规则列表接口](https://support.huaweicloud.com/api-codecheck/ListRules.html)获取规则配置ID。 **取值范围:** 不涉及。 | | template_id | String | **参数解释:** 规则集ID。可调用[查询规则集列表](https://support.huaweicloud.com/api-codecheck/ListRulesets.html)获取规则集ID。 **取值范围:** 32位UUID。 | | description | String | **参数解释:** 配置参数的描述。可不填。 **取值范围:** 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v2/{project_id}/ruleset/{ruleset_id}/rules ``` #### 响应示例 **状态码：200** 请求成功! ``` { "info" : [ { "rule_language" : "cpp", "rule_id" : "1614", "checked" : "1", "rule_name" : "A buffer must have size of 2 integers if used as parameter of pipe().", "rule_severity" : "1", "tags" : "cwe", "rule_config_list" : [ ] }, { "rule_language" : "cpp", "rule_id" : "1611", "checked" : "1", "rule_name" : "A buffer must have size of 2 integers if used as parameter of pipe().", "rule_severity" : "1", "tags" : "cwe", "rule_config_list" : [ { "id" : 250, "rule_id" : 11707, "template_id" : "906e7eac47dd4bde9c984f5e6f2a54e8", "option_key" : "threshold", "option_name" : "新增阈值", "option_value" : "10", "default_value" : "20", "description" : "代码复杂度超过阈值，则会被识别为超大圈复杂度，与圈复杂度统计区别在于统计SWITCH的时候，只统计SWITCH的个数，不统计case,default，必填" }, { "id" : 251, "rule_id" : 11707, "template_id" : "906e7eac47dd4bde9c984f5e6f2a54e8", "option_key" : "threshold_modify", "option_name" : "修改阈值", "option_value" : "30", "default_value" : "20", "description" : "代码复杂度超过阈值，则会被识别为超大圈复杂度。与圈复杂度统计区别在于统计SWITCH的时候，只统计SWITCH的个数，不统计case,default，修改阈值要比新增阈值大，非必填" } ] } ], "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)。