检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
查看规则集的规则列表 功能介绍 根据项目ID、规则集ID等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/ruleset/{ruleset_id}/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id
项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID ruleset_id 是 String 规则集ID 表2 Query参数
如何调用API 构造请求 认证鉴权 返回结果
查询规则集列表 功能介绍 根据项目ID、语言等条件查询规则集列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个Code
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个Code
项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID ruleset_id 是 String 规则集ID 表2 Query参数
删除自定义规则集 功能介绍 删除自定义规则集,正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
创建自定义规则集 功能介绍 可根据需求灵活的组合规则。 调用方法 请参见如何调用API。 URI POST /v2/ruleset 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。
第三次正式发布。本次变更说明如下: 修改代码示例中代码仓库地址信息。 2020-03-13 第二次正式发布。本次变更说明如下: 代码检查API接口项增加变更说明,如有疑问,请在帮助页面下方提交反馈。 2020-01-03 第一次正式发布。 2019-12-28
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限,详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
华为代码安全检查增强包里安全检查能力作为深度价值特性,能深度识别代码中安全风险和漏洞,提供了套餐包内规则不覆盖的安全类场景,比如数值错误、加密问题、数据验证问题等。针对业界的安全漏洞检测项提供了更深入的分析能力,比如,跨函数、跨文件、污点分析、语义分析等。 当前代码安全检查增强包一共有284条规则,涵盖Java语言61个
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
也可以通过其他接口查询概要等信息,更多使用方法参考API接口说明文档手册。 查询缺陷详情的响应结果。 相关参考 本示例中所有接口均可在华为云OpenAPI调试平台进行对应调试。 新建代码检查任务的API接口说明可参考新建检查任务。 执行代码检查任务的API接口说明可参考执行检查任务。
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在