相关操作 关于规则集的相关API接口可参考规则管理、查询任务的已选规则集列表v2、查询任务的已选规则集列表v3、查询任务规则集的检查参数v2、查询任务规则集的检查参数v3和修改任务规则集。 关于预置规则集的使用最佳实践可参考使用预置规则检查通用Git代码仓中的代码质量。 父主题:
参数解释: webhoo节点列表 取值范围: 不涉及 total Integer 参数解释: 总数 取值范围: 0-2147483647 表3 TaskWebhookInfo 参数 参数类型 描述 id String 参数解释: 主键32位UUID 取值范围: 不涉及 taskId
String 规则集ID 表2 Query参数 参数 是否必选 参数类型 描述 language 是 String 规则集语言 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用
头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 username 否 String 废弃参数。 access_token 否 String
files_total 文件总数。 扫描工程目录中符合源码文件后缀名的文件总个数,其中空文件不会统计在内。不同语言对应的文件后缀可参考表3。 folders_total 目录总数。 工程里目录的总个数。其中空目录不会被计算在内。 lines_per_file 文件平均代码行。 文件平均代码行=代码行总数/文件总数
相关操作 关于规则集的相关API接口可参考规则管理、查询任务的已选规则集列表v2、查询任务的已选规则集列表v3、查询任务规则集的检查参数v2、查询任务规则集的检查参数v3和修改任务规则集。 关于自定义规则以及规则集的最佳实践可参考使用自定义规则检查CodeArts Repo代码仓中的代码质量。
说明 1 创建代码检查任务所属项目 创建代码检查任务所属的项目。 2 创建CodeArts Repo代码仓 创建代码检查任务使用的代码仓。 3 创建规则文件 创建自定义规则时需要上传使用的规则文件。 4 创建自定义规则 在代码检查服务页面创建自定义规则。 5 创建自定义规则集 自定
是否需要扩展信息:未启用语言对应的可选规则集、规则集的名称和使用状态。 约束限制: 不涉及。 取值范围: true:需要。 false:不需要。 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用I
10、CWE/SANS TOP 25。内置华为多年研发经验总结的5种语言编程规范(C/C++/JAVA/Python/GO)要求。 商用 产品介绍 3 支持主流开发语言,内置7000+检查规则,便于用户开箱即用 支持C/C++、Java、Python、GO、JavaScript、CSS、H
oken的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 task_id String 参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArt
获取执行记录ID。 约束限制: 不涉及。 取值范围: 32位UUID。 默认取值: 无,不传时查询任务的最近一次的检查日志。 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用I
Repo:检查当前项目下Repo代码仓中的代码质量。 任务名称 代码检查任务名称,可自定义。 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为3~128。 代码仓 选择需要检查的代码仓库。 默认分支 选择需要检查的仓库分支。 检查语言 选择需要检查的代码语言。当前支持检查的语言可参考支持主流开发语言。
提交前,是否自动触发代码检查”;取消勾选“代码提交前,是否自动触发代码检查”则关闭该功能。 2 检查模式 无需配置,默认为本地扫描模式。 3 配置扫描排除目录 支持填写相对代码仓的相对目录,例如:一级目录写 目录名,二级目录写 目录1名/目录2名;多个指定目录扫描,可用;号隔开。