获取规范信息
功能介绍
获取规范信息。
调用方法
请参见如何调用API。
URI
GET /v1/rule/criterion-rule/query/{criterion_rule_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
criterion_rule_id |
是 |
String |
参数解释: 规范的id。通过获取规则列表接口接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 32位uuid。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
httpStatus |
String |
参数解释: HTTP响应状态,接口响应成功时为"OK",接口响应失败时为其他HTTP状态码。如INTERNAL_SERVER_ERROR为接口内部异常,BAD_REQUEST是参数校验异常。 取值范围:
|
result |
CriterionRuleParam object |
参数解释: 规则信息。 取值范围: 不涉及。 |
status |
String |
参数解释: 接口响应状态。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 能力规则id。 取值范围: 不涉及。 |
name |
String |
参数解释: 能力规则的英文名称。 取值范围: 不涉及。 |
nameCn |
String |
参数解释: 能力规则的中文名称。 取值范围: 不涉及。 |
comments |
String |
参数解释: 中文描述信息。 取值范围: 不涉及。 |
commentsEn |
String |
参数解释: 英文描述信息。 取值范围: 不涉及。 |
type |
String |
参数解释: 规则类型。 取值范围: 不涉及。 |
goodExample |
String |
参数解释: 中文正确示例。 取值范围: 不涉及。 |
goodExampleEn |
String |
参数解释: 英文正确示例。 取值范围: 不涉及。 |
badExample |
String |
参数解释: 中文错误示例。 取值范围: 不涉及。 |
badExampleEn |
String |
参数解释: 英文错误示例。 取值范围: 不涉及。 |
recommend |
String |
参数解释: 中文修复建议。 取值范围: 不涉及。 |
recommendEn |
String |
参数解释: 英文修复建议。 取值范围: 不涉及。 |
severity |
String |
参数解释: 告警等级。 取值范围:
|
language |
String |
参数解释: 规则语言。 取值范围: 当前支持的语言有:ARKTS,C#,C++,CSS,GO,HTML,JAVA,JAVASCRIPT,KOTLIN,LUA,PHP,PYTHON,RUST,SCALA,SHELL,SQL,TYPESCRIPT。 |
userTag |
String |
参数解释: 用户标签。 取值范围: misra,GJB,autosar等。 |
systemTag |
String |
参数解释: 引擎名称。 取值范围: codemars,secbrella等。 |
supportIDE |
String |
参数解释: 规则是否支持IDE级检查。 取值范围:
|
supportVersion |
String |
参数解释: 规则是否支持版本级检查。 取值范围:
|
supportPersonal |
String |
参数解释: 规则是否支持门禁级检查。 取值范围:
|
sourceType |
String |
参数解释: 规则类型。 取值范围:
|
criterionType |
String |
参数解释: 业务类型分类。 取值范围: common,common_standard_recommend,security,security_standard_recommend等。 |
cwe |
String |
参数解释: cwe编号。 取值范围: 不涉及。 |
managers |
String |
参数解释: 规则集管理员。 取值范围: 用户id。多个id由英文逗号分隔。 |
options |
Array of CriterionOption objects |
参数解释: 规则关联的配置参数列表。 取值范围: 不涉及。 |
domainId |
String |
参数解释: 租户id。 取值范围:
|
creatorId |
String |
参数解释: 租户id。 取值范围:
|
canEdit |
Boolean |
参数解释: 当前用户是否具有修改该规则的权限。 取值范围:
|
canDelete |
Boolean |
参数解释: 当前用户是否具有删除该规则的权限。 取值范围:
|
lastReviser |
String |
参数解释: 规则最近一次更新的操作人。 取值范围: 用户名。 |
lastUpdateTime |
String |
参数解释: 规则最近一次更新的时间。 取值范围: 0时区标准时间。 |
creator |
String |
参数解释: 创建者。 取值范围: 自定义规则的创建者为用户名。 |
createTime |
String |
参数解释: 规则创建时间。 取值范围: 0时区标准时间。 |
toolVersion |
String |
参数解释: 规则版本。 取值范围: 不涉及。 |
uniqueId |
String |
参数解释: 能力规则唯一id。 取值范围: 32位uuid。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数解释: 参数值类型。 取值范围:
-字段为空,默认为STRING。 |
valueRange |
String |
参数解释: 配置参数取值范围。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v1/rule/criterion-rule/query/d084f2c46c1911f0aa9bfa163eed4919
响应示例
状态码:200
get criterion tool rule by criterion id
{ "httpStatus" : "OK", "status" : "success", "result" : { "alarmType" : "security", "badExample" : "", "batchChangeVersion" : [ ], "canDelete" : true, "canEdit" : true, "cleanCodeFeature" : "可读性,可维护性", "comments" : "", "creator" : "", "criterionType" : "common", "cwe" : "", "demo" : "", "engineType" : "selfDeveloped", "falsePosRate" : "", "flag" : false, "goodExample" : "", "id" : "0f52c885be1f4d1cb134d32324c1797d", "language" : "C", "lastReviser" : "", "lastUpdateTime" : "2020-10-14 15:50:23", "linkUrl" : "", "maintenanceDepart" : "", "maintenanceLevel" : "company", "manageOrganization" : "testOrg", "manageOrganizationOwner" : "testOwner", "managers" : "", "minSet" : 0, "name" : "#define of macro with same name as previously declared symbol symbol", "nameCn" : "#define of macro with same name as previously declared symbol symbol", "organization" : "", "recommend" : "", "reference" : "codeStandard", "referenceUrl" : "", "refs" : [ ], "relatedToolRules" : [ ], "ruleStatus" : "experiment", "severity" : "1", "source" : "软件分析Lab", "sourceType" : "1", "supportIDE" : "1", "supportPersonal" : "1", "supportVersion" : "1", "systemTag" : "clangTidy", "toolVersion" : "202306", "type" : "", "uniqueId" : "ea3329680df111ebb169fa163ee969af", "userTag" : "Hilint,待下线" } }
状态码:400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "网络繁忙,请稍后再试。" }
状态码:401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "认证信息过期。" }
状态码
状态码 |
描述 |
---|---|
200 |
get criterion tool rule by criterion id |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。