-
获取账号ID - 代码检查 CodeArts Check
在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
-
包年/包月 - 代码检查 CodeArts Check
力、并发扩展能力叠加。 不同版本套餐中,提供的功能特性及资源规格略有不同,详情请参见表1。 代码检查资源扩展包:在CodeArts或CodeArts Check套餐基础上,可以购买资源扩展包。 表1 代码检查套餐详情 代码检查套餐说明 适用场景 规格 特性 包年/包月计费 资源扩展按需计费
-
续费概述 - 代码检查 CodeArts Check
常使用,且代码检查任务的运行不受影响。代码检查服务到期后的状态说明,请参见到期后影响。 续费相关的功能 代码检查服务续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费 在代码检查服务订单的生命周期内,您可以随时通过控制台续费,以延长资源的使用时间。 自动续费
-
查询任务的高级选项 - 代码检查 CodeArts Check
/v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID task_id 是 String 任务ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否
-
历史扫描结果查询 - 代码检查 CodeArts Check
/v2/{project_id}/tasks/{task_id}/checkrecord 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID task_id 是 String 任务ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否
-
查询任务规则集的检查参数v2 - 代码检查 CodeArts Check
id}/check-parameters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID task_id 是 String 任务ID ruleset_id 是 String 规则集ID 表2 Query参数 参数 是否必选 参数类型
-
API概览 - 代码检查 CodeArts Check
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
-
查询任务检查失败日志 - 代码检查 CodeArts Check
il 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID task_id 是 String 任务ID 表2 Query参数 参数 是否必选 参数类型 描述 execute_id 否 String 任务单次的执行ID 请求参数 表3 请求Header参数
-
任务管理 - 代码检查 CodeArts Check
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
-
查询缺陷详情的统计 - 代码检查 CodeArts Check
URI GET /v2/tasks/{task_id}/defects-statistic 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
-
查询任务规则集的检查参数v3 - 代码检查 CodeArts Check
id}/check-parameters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID task_id 是 String 任务ID ruleset_id 是 String 规则集ID 表2 Query参数 参数 是否必选 参数类型
-
修订记录 - 代码检查 CodeArts Check
第二十二次正式发布。本次变更说明如下: 修改查询任务的已选规则集列表v3。 修改查询任务规则集的检查参数v3。 修改错误码。 2022-09-22 第二十一次正式发布。本次变更说明如下: 修改错误码。 2022-09-06 第二十次正式发布。本次变更说明如下: 修改示例1:查询任务列表。 修改示例2:查询缺陷概要。
-
规则管理 - 代码检查 CodeArts Check
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 父主题: API
-
审计与日志 - 代码检查 CodeArts Check
的管理事件和数据事件用于审计。 CTS的详细介绍和开通配置方法,请参见CTS快速入门。 CTS支持追踪的代码检查操作列表,请参见云审计服务支持的代码检查操作列表。 父主题: 安全
-
什么是代码检查 - 代码检查 CodeArts Check
助力企业成功。 产品形态包括:云服务和IDE插件。同时,还提供具有深度检查能力的代码检查安全特性包。 云服务代码检查功能列表 表1 云服务代码检查功能列表 功能 描述 编码问题检查 用编码问题检查规则集,对自己的代码进行编码问题缺陷检查。 代码安全检查 用代码安全检查规则集,对自己的代码进行代码安全风险和缺陷检查。
-
查询缺陷详情 - 代码检查 CodeArts Check
请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页索引,偏移量
-
配置代码检查任务基本信息 - 代码检查 CodeArts Check
授权成员使用代码检查服务。 修改检查任务名称和默认分支 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。 进入“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称和默认分支。 删除检查任务 在代码检查页面删除 单击代码检查任务所在行。
-
应用示例 - 代码检查 CodeArts Check
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
-
错误码 - 代码检查 CodeArts Check
0001" } 其中,“error_code”表示错误码,“error_msg”表示错误描述信息。 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 表1 错误码 状态码 错误码 错误信息 描述 处理措施
-
使用预置规则检查通用Git代码仓中的代码质量 - 代码检查 CodeArts Check
检查代码质量。 在导航栏选择“设置 > 通用设置 > 服务扩展点管理”。 单击“新建服务扩展点”,在下拉列表中选择“通用Git”。 在弹框中配置以下信息,单击“确定”。 表1 新建通用Git服务扩展点 参数 说明 是否必填 连接名称 自定义,支持中文、英文、数字、“-”、“_”、“