-
约束与限制 - 代码检查 CodeArts Check
12小时。 浏览器 目前适配的主流浏览器类型包括: Chrome浏览器:支持和测试最新的3个稳定版本 Firefox浏览器:支持和测试最新的3个稳定版本 Microsoft Edge浏览器:Win10默认浏览器,支持和测试最新的3个稳定版本 推荐使用Chrome、Firefox浏览器,效果会更好。
-
开通并授权使用CodeArts Check - 代码检查 CodeArts Check
为不同角色配置代码检查服务的使用权限,各角色具备的默认权限如表1。 表1 代码检查服务默认角色权限 资源权限/角色 项目管理员 项目经理 开发人员 测试经理 测试人员 参与者 浏览者 运维经理 产品经理 系统工程师 Committer 代码检查任务 创建 √ √ √ × × × × × × √ √
-
获取账号ID - 代码检查 CodeArts Check
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
-
认证鉴权 - 代码检查 CodeArts Check
oken加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth":
-
自研代码检查引擎 - 代码检查 CodeArts Check
华为内部(15W+开发人员,日均500亿行扫描)大规模持续使用和打磨而成。 覆盖了业界主流开发语言,针对代码的可读、可维护、安全、可靠、可测试、高效、可移植等方面进行全面的分析。 融合了多年对代码质量及可信度提升方面持续思考与探索、实践,积累了丰富的检查规则。 父主题: 产品特性
-
构造请求 - 代码检查 CodeArts Check
请求消息头之外的内容。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token获取请求认证接口,您可以从接口的请求部分看到所需的请求参数及
-
配置代码检查任务通知管理 - 代码检查 CodeArts Check
单击Webhook文本框旁的“复制”获取钉钉Webhook地址。 将“钉钉通知”开关设置为状态。 选择通知场景,并填写Webhook地址,单击“测试”确保Webhook地址可用。 单击“保存”。 配置完成后,当任务运行结果满足事件类型时,代码检查服务会发送消息到指定的钉钉群。 配置代码检查服务企业微信通知
-
“代码编写、代码合并、版本发布”三层缺陷防护 - 代码检查 CodeArts Check
这一活动实践要求已是安全开发过程SDL、DevSecOps等众多优秀开发模式推荐进行的实践要求。 代码检查服务提供丰富的API接口、涵括任务新建、任务设置、任务扫描、任务报告解析等检查业务全流程,支持用户使用接口方式无缝集成到自建CI/CD或者CodeArts,作业数据灵活对接到客户看板,代码质量可视、可管理。
-
规则管理 - 代码检查 CodeArts Check
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 父主题: API
-
API概览 - 代码检查 CodeArts Check
任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
-
修订记录 - 代码检查 CodeArts Check
修改示例1:查询任务列表。 修改示例2:查询缺陷概要。 2022-08-29 第十九次正式发布。本次变更说明如下: 修改查询缺陷概要。 修改获取规则列表接口。 2022-06-30 第十八次正式发布。本次变更说明如下: 增加历史扫描结果查询。 2022-02-26 第十七次正式发布。本次变更说明如下:
-
查询任务执行状态 - 代码检查 CodeArts Check
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表3 响应Body参数
-
查询缺陷详情的统计 - 代码检查 CodeArts Check
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表3 响应Body参数
-
查询任务的高级选项 - 代码检查 CodeArts Check
Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表4 响应Body参数
-
查询任务的已选规则集列表v2 - 代码检查 CodeArts Check
否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表3 响应Body参数
-
查询任务的已选规则集列表v3 - 代码检查 CodeArts Check
否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表4 响应Body参数
-
历史扫描结果查询 - 代码检查 CodeArts Check
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表4 响应Body参数
-
查询任务检查失败日志 - 代码检查 CodeArts Check
否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表4 响应Body参数
-
查询规则集列表 - 代码检查 CodeArts Check
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表4 响应Body参数
-
修改任务规则集 - 代码检查 CodeArts Check
是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 表3 请求Body参数 参数 是否必选 参数类型