API参考

Size: px

Start display at page:

Download "API参考"

泊釜康
5 years ago
Views:

1 文档版本 03 发布日期华为技术有限公司

2 版权所有华为技术有限公司 2018 保留一切权利非经本公司书面许可, 任何单位和个人不得擅自摘抄复制本文档内容的部分或全部, 并不得以任何形式传播商标声明和其他华为商标均为华为技术有限公司的商标本文档提及的其他所有商标或注册商标, 由各自的所有人拥有注意您购买的产品服务或特性等应受华为公司商业合同和条款的约束, 本文档中描述的全部或部分产品服务或特性可能不在您的购买或使用范围之内除非合同另有约定, 华为公司对本文档内容不做任何明示或默示的声明或保证由于产品版本升级或其他原因, 本文档内容会不定期进行更新除非另有约定, 本文档仅作为使用指导, 本文档中的所有陈述信息和建议不构成任何明示或暗示的担保华为技术有限公司地址 : 深圳市龙岗区坂田华为总部办公楼邮编 : 网址 : 客户服务邮箱 : support@huawei.com 客户服务电话 : i

3 目录目录 1 接口调用指南获取检查任务列表获取检查任务指标获取任务配置的规则集模板查询任务历史检查指标创建检查任务附录通用请求返回值错误码说明文档修订记录 ii

4 1 接口调用指南 1 接口调用指南软件开发服务 (DevCloud) 接口调用指南包含 : 接口调用方法公共消息头响应 1

5 2.1 获取检查任务列表 2.2 获取检查任务指标 2.3 获取任务配置的规则集模板 2.4 查询任务历史检查指标 2.5 创建检查任务 2.1 获取检查任务列表功能介绍根据 DevCloud 项目 ID 获取任务列表 URI 请求 URI 格式 GET codecheck/v1/projects/project_id/tasks 参数说明参数名称是否为必选参数类型说明 project_id 是 String DevCloud 项目 ID start_index 否起始编号, 从 1 开始 page_size 否每页包含数据条数, 默认为 100 请求样例 GET codecheck/v1/projects/acef16a a6b96ebf432808b002/tasks?start_index=1&page_size=100 2

6 响应要素说明参数名称参数类型描述 task_id String 任务 ID task_name String 任务名称 creator_id String 任务创建人 git_url String Git 地址 git_branch String Git 分支 created_time String 任务创建时间请求结果按创建时间倒序返回格式 :yyyy-mm-dd HH:MM:ss last_check_time String 最近一次检查时间请求结果按创建时间倒序返回格式 :yyyy-mm-dd HH:MM:ss 响应样例 "result": [ "task_id": "1109e058018b44d4b009bb6f3efb813c", "task_name": "java- 用量上报 ", "creator_id": "330a2a1f5a96434eb b7feb", "git_url": "git@codehub.devcloud.huawei.com:16f55994a b3eb0f29c2284ff0/ javaandr.git", "git_branch": "master", "created_at": " :45:41", "last_check_time": " :05:11", "task_id": "6f9a89cb36894fc5a5e9c486f434d9bd", "task_name": "cpp908", "creator_id": "330a2a1f5a96434eb b7feb", "git_url": "git@codehub.devcloud.huawei.com:16f55994a b3eb0f29c2284ff0/ cpp.git", "git_branch": "master", "created_at": " :30:18", "last_check_time": " :15:13", "task_id": "7eba46f9728f46f38e75bf5523ab064a", "task_name": "c789", "creator_id": "330a2a1f5a96434eb b7feb", "git_url": "git@codehub.devcloud.huawei.com:16f55994a b3eb0f29c2284ff0/ css020.git", "git_branch": "master", "created_at": " :28:38", "last_check_time": " :05:11" ], "error": null, "status": "success" 3

7 返回值请参见 3.1 通用请求返回值 2.2 获取检查任务指标功能介绍根据检查任务 ID 获取详细指标 URI 请求 URI 格式 GET codecheck/v1/tasks/task_id 参数说明参数名称是否为必选参数类型说明 task_id 是 String 检查任务 ID 请求样例 GET codecheck/v1/tasks/acef16a a6b96ebf432808b002 响应要素说明参数名称参数类型描述 task_id String 任务 ID task_name String 任务名称 creator_id String 任务创建人 ID git_url String 任务 Git 地址 git_branch String Git 分支名称 last_check_tim e code_line_tota l String 最后一次检查时间格式 :yyyy-mm-dd HH:MM:ss 代码行总数 code_line 有效代码行数 code_quality Double 代码质量 defects_count 缺陷数 issue_count 问题数 4

8 参数名称参数类型描述 task_status 任务状态 : 2 成功 1 失败 0 运行中 risk_coefficien t duplication_co unt complexity_co unt complexity_av g duplicated_lin es 风险指数代码重复行数圈复杂度问题数平均圈复杂度问题数重复行数 comment_lines 注释行数 comment_ratio 注释比例 duplicated_blo cks String 重复代码块 last_exec_time 最后一次检查耗时单位 :MM 分 ss 秒响应样例 "result": "task_id": "1109e058018b44d4b009bb6f3efb813c", "task_name": "java- 用量上报 ", "creator_id": "330a2a1f5a96434eb b7feb", "git_url": "git@codehub.devcloud.huawei.com:16f55994a b3eb0f29c2284ff0/ javaandr.git", "git_branch": "master", "last_check_time": " :45:50", "code_line_total": 19633, "code_line": 9603, "code_quality": 16.2, "issue_count": 15, "task_status": 2, "risk_coefficient": 219, "duplication_ratio": "3.6%", "complexity_count": 29, "duplicated_lines": 716, "comment_lines": 1482, "comment_ratio": "9.9%", "duplicated_blocks": 42, "last_exec_time": "1 分 19 秒 ", "check_type": "source", "created_at": " :45:41", "error": null, 5

9 "status": "success" 返回值请参见 3.1 通用请求返回值 2.3 获取任务配置的规则集模板功能介绍根据检查任务 ID 获取配置的规则集模板 URI 请求 URI 格式 GET codecheck/v1/tasks/task_id/templates? start_index=start_index&page_size=page_size 参数说明参数名称是否为必选参数类型说明 task_id 是 String 检查任务 ID start_index 否起始编号, 从 1 开始 page_size 否每页包含数据条数, 默认为 100 请求样例 GET codecheck/v1/tasks/acef16a a6b96ebf432808b002/templates? start_index=1&page_size=20 响应要素说明参数名称参数类型描述 id String 规则集模板 ID name String 规则集模板名称 language String 规则集对应的检查语言响应样例 "result": [ "id": "e0b7f3e087e811e7abf8286ed489051c", 6

10 "name": "Java 致命问题规则集 ", "language": "java" ], "error": null, "status": "success" 返回值请参见 3.1 通用请求返回值 2.4 查询任务历史检查指标功能介绍根据检查任务 ID 查询历史检查指标说明仅对新检查数据有效 URI 请求 URI 格式 GET codecheck/v1/tasks/task_id/histories? start_index=start_index&page_size=page_size 参数说明参数名称是否为必选参数类型说明 task_id 是 String 检查任务 ID start_index 否起始编号, 从 1 开始 page_size 否每页包含数据条数, 默认为 100 请求样例 GET codecheck/v1/tasks/acef16a a6b96ebf432808b002/histories? start_index=1&page_size=20 响应要素说明参数名称参数类型描述 snapshot_id 该次检查的快照 ID 7

11 参数名称参数类型描述 check_time String 检查时间格式 :yyyy-mm-dd HH:MM:ss code_line_total_co unt 代码行总数 code_line_count 有效代码行数 code_quality Double 代码质量 new_issue_count 新问题数 risk_coefficient 风险指数 complexity_count 圈复杂度问题数 duplicated_lines_c ount duplicated_blocks_ count 重复代码行数重复代码块数 duplicated_ratio String 代码重复比率, 如 4.5% comment_lines_co unt 注释行数 comment_ratio String 注释比率, 如 4.5% 响应样例 "result": [ "snapshot_id": 60579, "check_time": " :18:37", "code_line_total_count": 19633, "code_line_count": 13516, "code_quality": 14.9, "new_issue_count": 31, "risk_coefficient": 202, "complexity_count": 34, "duplicated_lines_count": 716, "duplicated_blocks_count": 42, "duplicated_ratio": "3.6%", "comment_lines_count": 1482, "comment_ratio": "9.9%" ], "error": null, "status": "success" 返回值请参见 3.1 通用请求返回值 8

12 2.5 创建检查任务功能介绍创建任务 URI 请求 URI 格式 POST codecheck/v1/projects/project_id/tasks 参数说明参数名称是否为必选参数类型说明 project_id 是 String 检查任务 ID name 是 String 任务名称 git_url 是 String 代码仓库地址 git_branch 是 String 代码仓库分支 check_type 是 Array 源码或包安全 source/ package language 是 Array 支持语言 : java/js/web/css/cpp/androidgradle/php/python/csharp 请求样例 POST codecheck/v1/projects/a07bf dfee105e /tasks 响应响应样例 "name": "test_check", "git_url": "git@codehub.devcloud.huawei.com:cd01bb604e6348f79ac f49ccc/asfds.git", "git_branch": "master", "check_type": ["source"], "language": ["java", "js"] 返回值请参见 3.1 通用请求返回值 9

13 3 附录 3 附录 3.1 通用请求返回值 3.2 错误码说明 3.1 通用请求返回值请参见 DevCloud 开发指南中通用请求返回值 3.2 错误码说明错误码说明 Bad Request. Get region information failed. Get order information failed. Service has already opened. Service opened again after 24 hours from closed. Connection time out. Socket time out. Service opened failed. 10

14 3 附录 Other unknown error. 11

15 4 文档修订记录 4 文档修订记录文档修订记录累积了每次文档更新的说明最新版本的文档包含以前所有文档版本的更新内容修订记录第三次正式发布本次变更说明如下 : 增加 2.3 获取任务配置的规则集模板增加 2.4 查询任务历史检查指标增加 2.5 创建检查任务第二次正式发布本次变更说明如下 : 修改 2.1 获取检查任务列表修改 2.2 获取检查任务指标发布日期第一次正式发布

API参考

API参考文档版本 03 发布日期 2019-06-20 华为技术有限公司版权所有华为技术有限公司 2019 保留一切权利非经本公司书面许可, 任何单位和个人不得擅自摘抄复制本文档内容的部分或全部, 并不得以任何形式传播商标声明和其他华为商标均为华为技术有限公司的商标本文档提及的其他所有商标或注册商标, 由各自的所有人拥有注意您购买的产品服务或特性等应受华为公司商业合同和条款的约束, 本文档中描述的全部或部分产品