{"base_path":"/","components":null,"consumes":"","definitions":{"ErrorResponse":{"properties":{"error_code":{"description":"错误码","example":"CC.00000000","type":"string"},"error_msg":{"description":"错误描述","example":"网络繁忙,请稍后再试","type":"string"}}},"ListTemplateRulesRes":{"properties":{"info":{"description":"规则集的规则列表信息","items":{"$ref":"#/definitions/RuleItem"},"type":"array"},"total":{"description":"总数","example":2,"type":"integer"}},"required":["info","total"]},"RuleConfig":{"properties":{"default_value":{"description":"默认值","example":20,"type":"string"},"description":{"description":"描述","example":"代码复杂度超过阈值,则会被识别为超大圈复杂度,与圈复杂度统计区别在于统计SWITCH的时候,只统计SWITCH的个数,不统计case,default,必填","type":"string"},"id":{"description":"规则配置ID","example":251,"type":"integer"},"option_key":{"description":"当前规则配置项key","example":"threshold","type":"string"},"option_name":{"description":"当前规则配置项名称","example":"threshold","type":"string"},"option_value":{"description":"当前","example":10,"type":"string"},"rule_id":{"description":"规则ID","example":11707,"type":"integer"},"template_id":{"description":"规则集id","example":"99f573075fe24e769ad96c676511c823","type":"string"}}},"RuleItem":{"properties":{"checked":{"description":"规则状态0:未启用,1:已启用","example":"1","type":"string"},"rule_config_list":{"description":"规则配置参数阈值相关信息","items":{"$ref":"#/definitions/RuleConfig"},"type":"array"},"rule_id":{"description":"规则id","example":8048,"type":"string"},"rule_language":{"description":"规则所属语言","example":"Java","type":"string"},"rule_name":{"description":"规则名称","example":"\\\"Arrays.stream\\\" should be used for primitive arrays","type":"string"},"rule_severity":{"description":"规则问题级别","example":1,"type":"string"},"rule_tages":{"description":"规则标签","example":"bug","type":"string"}}}},"description":null,"group_id":"6e24e1d8225c45beaaeeceee605429ba","host":"codecheck-ext.cn-north-4.myhuaweicloud.com","id":"aae8fabff047411f9ebc80f83a22092c","info_version":"v2","method":"get","name":"ListTemplateRules","parameters":{},"paths":{"/v2/{project_id}/ruleset/{ruleset_id}/rules":{"get":{"consumes":["application/json"],"deprecated":false,"description":"根据项目ID、规则集ID等条件查询规则列表。","operationId":"ListTemplateRules","parameters":[{"description":"用户Token\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":100000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX..."},{"description":"项目ID","in":"path","name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"规则集ID","in":"path","name":"ruleset_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"default":"1","description":"规则状态\n\n'1查询全部,2已启动,3未启用'","in":"query","name":"types","required":true,"type":"string","x-example":"1"},{"description":"规则语言","in":"query","name":"languages","type":"string","x-example":"java"},{"description":"规则所属标签","in":"query","name":"tags","type":"string","x-example":"bug"},{"allowEmptyValue":true,"default":0,"description":"分页索引,偏移量","format":"int32","in":"query","minimum":0,"name":"offset","type":"integer","x-example":1},{"allowEmptyValue":true,"default":100,"description":"每页显示的数量","format":"int32","in":"query","maximum":1000,"minimum":1,"name":"limit","type":"integer","x-example":100}],"produces":["application/json"],"responses":{"200":{"description":"Request succeeded!","examples":{"application/json":{"info":[{"checked":"1","rule_config_list":[],"rule_id":"1614","rule_language":"cpp","rule_name":"A buffer must have size of 2 integers if used as parameter of pipe().","rule_severity":"1","rule_tages":"cwe"},{"checked":"1","rule_config_list":[{"default_value":"20","description":"代码复杂度超过阈值,则会被识别为超大圈复杂度,与圈复杂度统计区别在于统计SWITCH的时候,只统计SWITCH的个数,不统计case,default,必填","id":250,"option_key":"threshold","option_name":"新增阈值","option_value":"10","rule_id":11707,"template_id":"906e7eac47dd4bde9c984f5e6f2a54e8"},{"default_value":"20","description":"代码复杂度超过阈值,则会被识别为超大圈复杂度。与圈复杂度统计区别在于统计SWITCH的时候,只统计SWITCH的个数,不统计case,default,修改阈值要比新增阈值大,非必填","id":251,"option_key":"threshold_modify","option_name":"修改阈值","option_value":"30","rule_id":11707,"template_id":"906e7eac47dd4bde9c984f5e6f2a54e8"}],"rule_id":"1611","rule_language":"cpp","rule_name":"A buffer must have size of 2 integers if used as parameter of pipe().","rule_severity":"1","rule_tages":"cwe"}],"total":2}},"schema":{"$ref":"#/definitions/ListTemplateRulesRes"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"CC.00000000","error_msg":"网络繁忙,请稍后再试"}},"schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized","examples":{"application/json":{"error_code":"CC.00000003","error_msg":"认证信息过期"}},"schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apig-auth-iam":[]}],"summary":"查看规则集的规则列表","tags":["规则管理"],"x-apigateway-backend":{"httpEndpoints":{"address":"10.63.38.190:40115","description":"","method":"GET","path":"/codecheck/v2/{project_id}/ruleset/{ruleset_id}/rules","scheme":"https","timeout":60000},"parameters":[{"description":"逻辑region","in":"header","name":"X-AUTH-REGION","origin":"CONSTANT","value":"cn-north-7"}],"type":"HTTP"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-request-type":"public","x-is-registered":"Y","x-name":"查询规则集的规则列表","x-request-examples-1":"GET https://{endpoint}/v2/{project_id}/ruleset/{ruleset_id}/rules","x-request-examples-description-1":"","x-support-sdk":"Y","x-version":"v2"}}},"product_short":"CodeCheck","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-app-optional":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-opt":{"access-auth-type":"optional"},"x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-none":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM_NONE"}},"summary":"查看规则集的规则列表","tags":"规则管理","uri":null,"version":"2.0"}