# 获取规范信息 - ShowCriterionRule #### 功能介绍 该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::getRule | Read | - | - | - | - | #### URI GET /v1/rule/criterion-rule/query/{criterion_rule_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | criterion_rule_id | 是 | String | **参数解释：** 规范的ID。通过[获取规则列表接口](https://support.huaweicloud.com/api-codecheck/ListRules.html)查询项目列表获取。 **约束限制：** 不涉及。 **取值范围：** 32位UUID。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | httpStatus | String | **参数解释：** HTTP响应状态。 **取值范围：** - OK：请求已成功处理，服务器返回了请求的资源或操作结果。 - ACCEPTED：请求已被服务器接受，但处理尚未完成（通常用于异步操作）。 - INTERNAL_SERVER_ERROR：接口内部异常。 - BAD_REQUEST：参数校验异常。 | | result | [CriterionRuleParam] object | **参数解释：** 规则信息。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 接口响应状态。 **取值范围：** - success：接口响应成功。 - error：接口响应失败。 | 表4CriterionRuleParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 能力规则ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 能力规则的英文名称。 **取值范围：** 不涉及。 | | nameCn | String | **参数解释：** 能力规则的中文名称。 **取值范围：** 不涉及。 | | comments | String | **参数解释：** 中文描述信息。 **取值范围：** 不涉及。 | | category | String | **参数解释：** 规则小类。 **取值范围：** 不涉及。 | | treeNodeParentId | String | **参数解释：** 树节点信息。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 规则类型。 **取值范围：** 不涉及。 | | goodExample | String | **参数解释：** 中文正确示例。 **取值范围：** 不涉及。 | | badExample | String | **参数解释：** 中文错误示例。 **取值范围：** 不涉及。 | | recommend | String | **参数解释：** 中文修复建议。 **取值范围：** 不涉及。 | | severity | String | **参数解释：** 告警等级。 **取值范围：** - 0：致命。 - 1：严重。 - 2：一般。 - 3：提示。 | | language | String | **参数解释：** 规则语言。 **取值范围：** - ARKTS - C# - CANGJIE - C++ - CSS - GO - HTML - JAVA - JAVASCRIPT - KOTLIN - LUA - PHP - PYTHON - RUST - SCALA - SHELL - SQL - TERRAFORM - TYPESCRIPT - AZURERESOURCEMANAGER - DOCKER - KUBERNETES | | userTag | String | **参数解释:** 用户标签。含有业界标准、安全与质量、是否编译类规则的标签。 **取值范围:** - security：安全类。 - security_enhance：代码检查安全增强。 - compile：编译类。 - cwe - iso5055 - huawei - top10 - top25 - cert - misra - autosar - PCI DSS - GJB | | systemTag | String | **参数解释:** 引擎名称。 **取值范围:** codemars，secbrella等。 | | supportIDE | String | **参数解释：** 规则是否支持IDE级检查。 **取值范围：** - 1：支持。 - 0：不支持。 | | supportVersion | String | **参数解释：** 规则是否支持版本级检查。 **取值范围：** - 1：支持。 - 0：不支持。 | | supportPersonal | String | **参数解释：** 规则是否支持门禁级检查。 **取值范围：** - 1：支持。 - 0：不支持。 | | sourceType | String | **参数解释：** 规则类型。 **取值范围:** - 0：自定义规则。 - 1：系统规则。 | | criterionType | String | **参数解释：** 业务类型分类。 **取值范围:** - common：通用。 - common_standard_recommend：通用建议。 - common_standard_rule：通用规则。 - security：安全。 - security_standard_recommend：安全建议。 - security_standard_rule：安全规则。 | | cwe | String | **参数解释：** cwe编号。 **取值范围:** 不涉及。 | | managers | String | **参数解释：** 规则集管理员。 **取值范围：** 用户ID。多个ID用英文逗号分隔。 | | options | Array of [CriterionOption] objects | **参数解释：** 规则关联的配置参数列表。 **取值范围：** 不涉及。 | | relatedToolRules | Array of [RelatedToolRule] objects | **参数解释：** 关联的工具规则列表 **取值范围：** 不涉及。 | | domainId | String | **参数解释：** 租户ID。 **取值范围:** - system：系统规则。 - 32位UUID：创建自定义规则的租户ID。 | | creatorId | String | **参数解释：** 租户ID。 **取值范围:** - system：系统规则。 - 32位UUID，创建自定义规则的用户ID。 | | canEdit | Boolean | **参数解释：** 当前用户是否具有修改该规则的权限。 **取值范围：** - true：有编辑的权限。 - false：没有编辑的权限。 | | canDelete | Boolean | **参数解释：** 当前用户是否具有删除该规则的权限。 **取值范围：** - true：有删除的权限。 - false：没有删除的权限。 | | lastReviser | String | **参数解释：** 规则最近一次更新的操作人。 **取值范围：** 用户名。 | | lastUpdateTime | String | **参数解释：** 规则最近一次更新的时间。 **取值范围：** 0时区标准时间。 | | creator | String | **参数解释：** 创建者。 **取值范围:** 自定义规则的创建者为用户名。 | | createTime | String | **参数解释：** 规则创建时间。 **取值范围：** 0时区标准时间。 | | toolVersion | String | **参数解释：** 规则版本。 **取值范围:** 不涉及。 | | uniqueId | String | **参数解释：** 能力规则唯一ID。 **取值范围:** 32位UUID。 | | batchChangeVersion | Array of strings | **参数解释：** 批量修改版本。 **取值范围:** 不涉及。 | | productVerification | Array of strings | **参数解释：** 产品验证情况。 **取值范围:** 不涉及。 | 表5RelatedToolRule | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 工具规则ID。 **取值范围：** 32位UUID。 | | canEdit | Boolean | **参数解释：** 当前用户是否具有修改该规则集的权限。 **取值范围：** - true：有编辑的权限。 - false：没有编辑的权限。 | | canDelete | Boolean | **参数解释：** 当前用户是否具有删除该规则集的权限。 **取值范围：** - true：有删除的权限。 - false：没有删除的权限。 | | lastReviser | String | **参数解释：** 规则集最近一次更新的操作人。 **取值范围：** 用户名。 | | lastUpdateTime | String | **参数解释：** 规则集最近一次更新的时间。 **取值范围：** 0时区标准时间。 | | creator | String | **参数解释：** 创建者。 **取值范围:** 自定义规则的创建者为用户名。 | | createTime | String | **参数解释：** 规则集创建时间。 **取值范围：** 0时区标准时间。 | | refNum | Integer | **参数解释：** 该字段已弃用。 **取值范围：** 不涉及。 | | refObjName | String | **参数解释：** 该字段已弃用。 **取值范围：** 不涉及。 | | refs | Array of strings | **参数解释：** 该字段已弃用。 **取值范围：** 不涉及。 | | toolVersion | String | **参数解释：** 规则版本。 **取值范围:** 不涉及。 | | uniqueId | String | **参数解释：** 工具规则唯一ID。 **取值范围:** 32位UUID。 | | name | String | **参数解释：** 工具规则英文名称。 **取值范围:** 不涉及。 | | nameCn | String | **参数解释：** 工具规则中文名称。 **取值范围:** 不涉及。 | | comments | String | **参数解释：** 描述。 **取值范围:** 不涉及。 | | checkerId | String | **参数解释：** 引擎ID。 **取值范围:** 32位UUID。 | | source | String | **参数解释：** 工具来源。 **取值范围:** 不涉及。 | | type | String | **参数解释：** 规则类型。 **取值范围:** - 0：自定义规则。 - 1：系统规则。 - 3：用户导入的第三方规则。 | | checkerScenario | String | **参数解释：** 规则使用场景。 **取值范围:** 不涉及。 | | version | String | **参数解释：** 工具规则版本。 **取值范围:** 不涉及。 | | online | String | **参数解释：** 工具规则上线状态。 **取值范围:** - 0：下线。 - 1：上线。 | | fixStatus | String | **参数解释：** 是否自动修复规则。 **取值范围:** - 0：否。 - 1：是。 | | isPersonalDefault | String | **参数解释：** 门禁级是否默认使用。 **取值范围:** - 0：否。 - 1：是。 | | isVersionDefault | String | **参数解释：** 版本级是否默认使用。 **取值范围:** - 0：否。 - 1：是。 | | contextLines | Integer | **参数解释：** 上下文各展示行数。 **取值范围:** 大于0的整数。 | | checkerName | String | **参数解释：** 引擎名称。 **取值范围:** 不涉及。 | | checkerToolVersion | String | **参数解释：** 引擎工具版本。 **取值范围:** 不涉及。 | | language | String | **参数解释：** 规则语言。 **取值范围：** - ARKTS - C# - CANGJIE - C++ - CSS - GO - HTML - JAVA - JAVASCRIPT - KOTLIN - LUA - PHP - PYTHON - RUST - SCALA - SHELL - SQL - TERRAFORM - TYPESCRIPT - AZURERESOURCEMANAGER - DOCKER - KUBERNETES | | checkerVersion | String | **参数解释：** 引擎版本。 **取值范围:** 不涉及。 | | lastReversionId | String | **参数解释：** 最新版本工具规则ID。 **取值范围:** 不涉及。 | | fileId | String | **参数解释：** 文件ID。仅自定义规则时该ID不为空。 **取值范围:** 不涉及。 | | options | Array of [CriterionOption] objects | 规则options | 表6CriterionOption | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ruleId | String | **参数解释：** 工具规则ID。 **取值范围：** 32位UUID。 | | ruleName | String | **参数解释：** 工具规则名。 **取值范围：** 不涉及。 | | criterionId | String | **参数解释：** 能力规则ID。 **取值范围：** 32位UUID。 | | criterionSetId | String | **参数解释：** 规则集ID。 **取值范围：** 32位UUID。 | | optionKey | String | **参数解释：** 配置参数项的key。 **取值范围：** 不涉及。 | | name | String | **参数解释：** option名称。 **取值范围：** 不涉及。 | | optionValue | String | **参数解释：** 配置参数的值，由用户配置。若为空，则使用默认值。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 配置参数的解释信息。 **取值范围：** 不涉及。 | | defaultValue | String | **参数解释：** 默认值。 **取值范围：** 不涉及。 | | valueType | String | **参数解释：** 参数值类型。 **取值范围：** - BOOLEAN：布尔类型。 - FLOAT：浮点数类型。 - INTEGER：整数类型。 - STRING：字符串类型。 - 字段为空：默认为STRING。 | | valueRange | String | **参数解释：** 配置参数取值范围。 **取值范围：** 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v1/rule/criterion-rule/query/d084f2c46c1911f0aa9bfa163eed4919 ``` #### 响应示例 **状态码：200** 请求成功! ``` { "httpStatus" : "OK", "status" : "success", "result" : { "badExample" : "", "batchChangeVersion" : [ ], "canDelete" : true, "canEdit" : true, "comments" : "", "creator" : "", "criterionType" : "common", "cwe" : "", "demo" : "", "goodExample" : "", "id" : "0f52c885be1f4d1cb134d32324c1797d", "language" : "C++", "lastReviser" : "", "lastUpdateTime" : "2020-10-14 15:50:23", "managers" : "", "name" : "#define of macro with same name as previously declared symbol symbol", "nameCn" : "#define of macro with same name as previously declared symbol symbol", "recommend" : "", "relatedToolRules" : [ ], "severity" : "1", "source" : "软件分析Lab", "sourceType" : "1", "supportIDE" : "1", "supportPersonal" : "1", "supportVersion" : "1", "systemTag" : "clangTidy", "toolVersion" : "202306", "type" : "", "uniqueId" : "ea3329680df111ebb169fa163ee969af", "userTag" : "Hilint,待下线" } } ``` **状态码：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)。