检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询规则集列表-V3 功能介绍 根据项目ID、语言等条件查询规则集列表,与V2接口相比,限制了分页参数大小,V2接口后续将下线。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询任务规则集的检查参数v3 功能介绍 查询任务规则集的检查参数v3 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters 表1 路径参数 参数
查询任务的已选规则集列表v3 功能介绍 查询任务的已选规则集列表v3。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
自动续费 自动续费可以减少手动续费的管理成本,避免因忘记手动续费而导致代码检查服务资源被自动删除。自动续费的规则如下所述: 以订单的到期日计算第一次自动续费日期和计费周期。 订单自动续费周期以您选择的续费时长为准。例如,您选择了3个月,订单即在每次到期前自动续费3个月。 在订单到期前均可开通自动续费
查询分支任务列表 功能介绍 查询分支任务列表 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/branches 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个
查看徽标状态 执行完代码检查任务后,您可通过徽标状态查看代码健康度,并标识在代码仓库中。 代码检查服务中设置各个告警级别的影响度如下: 致命:5 严重:3 一般:1 提示:0.1 健康度=SUM ∑(告警数量*告警级别影响度)/代码量,各个健康度对应的标识如下: A:健康度<=0.001
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权
查询任务执行状态 功能介绍 根据任务ID查询任务执行状态。任务状态:0表示检查中,1表示检查失败,2表示检查成功,3表示任务中止。只有正在检查中才有进度的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/progress 表1 路径参数
约束与限制 购买须知 不同区域购买的资源不能跨区使用,需慎重选择。 如果已经购买了CodeArts套餐,则无需再单独购买CodeArts Check套餐。 命名限制 限制项 说明 检查任务名称 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为1~128。 规则集名称
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck
删除检查任务 功能介绍 删除检查任务,执行中的任务删除无法再查看 调用方法 请参见如何调用API。 URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
删除自定义规则集 功能介绍 删除自定义规则集,正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts
执行检查任务 功能介绍 执行检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/run 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck
获取任务的目录树 功能介绍 获取任务的目录树 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/listpathtree 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,
任务配置高级配置 功能介绍 任务配置高级配置,如自定义镜像 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
修改任务规则集 功能介绍 修改任务规则集。 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/ruleset 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck