# 规则查询过滤器 - ShowFilter #### 功能介绍 该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::listRules | List | - | - | - | - | #### URI GET /v1/criterion-filters 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | system_tag | 否 | String | **参数解释:** 引擎名称。 **约束限制:** 不涉及。 **取值范围:** sonarqube，wordstool，clangtidy，codemars，secbrella，cppcheck，apiengine，eslint，fixbotengine-java，fixbotengine-cxx，oat，pylint，SQLGuardian，cmetrics，codecheckrevive，clippy，detektout，cjlint，flake8，LuaGuardian，thirdpartycheck，FossScan，Infer_Java，testengine。 **默认取值：** 不涉及。 | | severitys | 否 | String | **参数解释:** 缺陷严重等级。 **约束限制:** 不涉及。 **取值范围:** - 0：致命。 - 1：严重。 - 2：一般。 - 3：提示。 **默认取值:** "0,1,2,3"，默认全部查询 | | languages | 否 | String | **参数解释：** 规则语言，多个以英文逗号分隔。 **约束限制:** 不涉及。 **取值范围：** - ARKTS - C# - CANGJIE - C++ - CSS - GO - HTML - JAVA - JAVASCRIPT - KOTLIN - LUA - PHP - PYTHON - RUST - SCALA - SHELL - SQL - TERRAFORM - TYPESCRIPT - AZURERESOURCEMANAGER - DOCKER - KUBERNETES **默认取值：** 不涉及。 | | search | 否 | String | **参数解释:** 关键字搜索。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | | set_id | 否 | String | **参数解释:** 规则集ID，通过[查询规则集列表](https://support.huaweicloud.com/api-codecheck/ListRulesets.html)接口可获取到规则集ID。 **约束限制:** 不涉及。 **取值范围:** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | | status | 否 | String | **参数解释:** 规则集规则是否为启用状态。 **约束限制:** 不涉及。 **取值范围:** - enable：启用状态。 - disable：非启用状态。 **默认取值：** enable。 | | inherit | 否 | String | **参数解释:** 继承类型。 **约束限制:** 不涉及。 **取值范围:** - true：继承的规则。 - false：非继承的规则。 - rewrite：改写的规则。 **默认取值：** 默认为null，查询所有继承类型规则。 | | onlines | 否 | String | **参数解释:** 上线状态。 **约束限制:** 不涉及。 **取值范围:** - 0：下线状态。 - 1：上线状态。 **默认取值：** 1 | | show_tool_version | 否 | String | **参数解释:** 展示版本。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | | tool_version | 否 | String | **参数解释:** 工具版本。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | | cwe_search | 否 | String | **参数解释:** cwe搜索。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | | compile | 否 | String | **参数解释:** 是否为编译类规则。 **约束限制:** 不涉及。 **取值范围:** - compile：编译类。 - noCompile：非编译类。 **默认取值：** 不涉及。 | | security | 否 | String | **参数解释:** 安全与质量分类。 **约束限制:** 不涉及。 **取值范围:** - security：安全类。 - security_enhance：代码检查安全增强。 - quality：质量类。 **默认取值：** 不涉及。 | | industry_standards | 否 | String | **参数解释:** 业界标准。 **约束限制:** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | | source_type | 否 | String | **参数解释:** 规则创建类型。 **约束限制:** 不涉及。 **取值范围:** - 0：自定义规则。 - 1：系统规则。 **默认取值：** 不涉及。 | | project_id | 否 | String | **参数解释:** 项目的32位UUID，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取。 **约束限制:** 不涉及。 **取值范围:** 32位项目ID。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | | operator | 是 | String | **参数解释：** 操作人，填写账号用户名。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~128\]个字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | httpStatus | String | **参数解释：** HTTP响应状态。 **取值范围：** - OK：请求已成功处理，服务器返回了请求的资源或操作结果。 - ACCEPTED：请求已被服务器接受，但处理尚未完成（通常用于异步操作）。 - INTERNAL_SERVER_ERROR：接口内部异常。 - BAD_REQUEST：参数校验异常。 | | result | [CriterionFilterInfo] object | **参数解释：** 规则过滤器。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 接口响应状态。 **取值范围：** - success：接口响应成功。 - error：接口响应失败。 | 表4CriterionFilterInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | languageInfoList | Array of [FilterUnit] objects | **参数解释：** 语言过滤器列表。 **取值范围：** 不涉及。 | | severityInfoList | Array of [FilterUnit] objects | **参数解释：** 告警等级过滤器列表。 **取值范围：** 不涉及。 | 表5FilterUnit | 参数 | 参数类型 | 描述 | |:---|:---|:---| | filterKey | String | **参数解释：** 过滤器指标名。 **取值范围：** - language：语言。 - severity：告警等级。 - status：规则启用状态。 - system_tag：检查引擎。 - compile：是否为编译规则。 - security：安全与质量。 - industryStandards：业界标准。 - onlines：上下线状态。 - sourceType：是否系统规则。 - inherit：继承状态。 | | filterValue | Integer | **参数解释：** 过滤器指标对应的数值。 **取值范围：** 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 查询过滤器。 ``` GET https://{endpoint}/v1/criterion-filters?system_tag=secbrella&languages=JAVA&tool_version=202507&onlines=1 ``` #### 响应示例 **状态码：200** query filters and counts by filter ``` { "httpStatus" : "OK", "result" : { "languageInfoList" : [ { "filterKey" : "java", "filterValue" : 4709 } ], "severityInfoList" : [ { "filterKey" : "1", "filterValue" : 209 } ] }, "status" : "success" } ``` **状态码：400** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确。" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期。" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | query filters and counts by filter | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。