huawei-cloud-api-definitions-CodeCheck 0.1.20240402

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"ErrorResponse":{"properties":{"error_code":{"description":"错误码","example":"CC.00000000","type":"string"},"error_msg":{"description":"错误描述","example":"网络繁忙,请稍后再试","type":"string"}}},"ListRulesetsRes":{"properties":{"info":{"description":"规则集列表信息","items":{"$ref":"#/definitions/RulesetItem"},"type":"array"},"total":{"description":"总数","example":2,"type":"integer"}},"required":["info","total"]},"RulesetItem":{"properties":{"creator_id":{"description":"创建人ID","example":"ae161856f2604229ae12056478a7919f","type":"string"},"creator_name":{"description":"创建人名称","example":"杨老板","type":"string"},"is_default":{"description":"是否该语言默认规则集,0不是,1是","example":"1","type":"string"},"is_default_template":{"description":"是否是系统规则集,0不是,1是","example":"1","type":"string"},"is_devcloud_project_default":{"description":"是否是项目下语言默认规则集,0不是,1是","example":"1","type":"string"},"is_used":{"description":"使用状态1使用中,0空闲中","example":"1","type":"string"},"language":{"description":"规则集语言","example":"Java","type":"string"},"rule_ids":{"description":"规则集包含的规则id","example":"11152,11153,11154,11155","type":"string"},"template_create_time":{"description":"创建人时间","example":"2021-10-21T02:14:55Z","type":"string"},"template_id":{"description":"规则集id","example":"99f573075fe24e769ad96c676511c823","type":"string"},"template_name":{"description":"规则集名称","example":"test","type":"string"}}}},"description":null,"group_id":"6e24e1d8225c45beaaeeceee605429ba","host":"codecheck-ext.cn-north-4.myhuaweicloud.com","id":"4308261b47344e798e4c105f513f506a","info_version":"v2","method":"get","name":"ListRulesets","parameters":{},"paths":{"/v2/{project_id}/rulesets":{"get":{"consumes":["application/json"],"deprecated":false,"description":"根据项目ID、语言等条件查询规则集列表。","operationId":"ListRulesets","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":"规则集类别\n\n'0只查询系统规则集,1只查询当前用户自定义规则集,2只查询其他用户自定义规则集,'0,1,2'或''查所有'","in":"query","name":"category","type":"string","x-example":"1"},{"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":[{"creator_id":"ae161856f2604229ae12056478a7919f","creator_name":"杨老板","is_default":"0","is_default_template":"1","is_devcloud_project_default":"0","is_used":"0","language":"Java","rule_ids":"","template_create_time":"2021-10-21T02:14:55Z","template_id":"9698e0cb9d2441c3bd8cec5f8641696e","template_name":"test1111"},{"creator_id":"ae161856f2604229ae12056478a7919f","creator_name":"杨老板","is_default":"0","is_default_template":"1","is_devcloud_project_default":"1","is_used":"1","language":"cpp","rule_ids":"11152,11153,11154,11155","template_create_time":"2021-10-21T02:14:55Z","template_id":"9698e0cb9d2441c3bd8cec5f8641696e","template_name":"test222"}],"total":2}},"schema":{"$ref":"#/definitions/ListRulesetsRes"}},"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}/rulesets","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}/rulesets","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"}