检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID 表2 Query参数 参数 是否必选 参数类型 描述 offset
token,参数计划下线,不建议使用 git_url 否 String 该任务对应的临时仓库地址,参数计划下线,不建议使用 git_branch 否 String 该任务对应的临时仓库分支,参数计划下线,不建议使用 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型
参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 GET
6 响应Body参数 参数 参数类型 描述 template_id String 规则集ID 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表8 响应Body
all(全屏蔽)、half(半屏蔽) 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String
URI POST /v2/{project_id}/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述
参数 是否必选 参数类型 描述 file_path 是 String 目录或文件路径 checkbox_status 是 String 屏蔽状态,包括unchecked(不屏蔽)、all(全屏蔽)、half(半屏蔽) 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型
目标状态,1:已解决;0:未解决;2:已忽略 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code
表4 TaskAdvancedSettingsItem 参数 是否必选 参数类型 描述 key 是 String 高级配置对应的名称 value 是 String 高级配置对应的取值 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String
默认1 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
规则集ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。
URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token
响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
当选中的规则集需配置扩展参数(此处以Java为例)时,单击“检查参数”,配置代码检查扩展参数并开启配置开关,完成后单击“确认”。 用户购买了代码安全检查增强包后,使用代码安全检查增强包规则集必须设置编译脚本检查参数。
单击“新建任务”,进入“新建任务”页面,参考如下参数说明配置参数信息,其他参数保持默认即可。 任务名称:代码检查任务名称,可自定义。例如:CheckTask01。 仓库:选择准备Repo代码仓中创建的代码仓“Repo01”。 检查语言:选择需要检查的代码语言。
参考表2在弹框中配置参数。 表2 GitCode服务扩展点参数说明 参数 说明 连接名称 服务扩展点的名称,可自定义。例如:GitCode。 Token 填写GitCode上获取的Token,获取方法如下: 登录GitCode。 单击页面右上角账号名称,选择“个人设置”。
在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表1配置参数。 表1 Repo代码源检查任务参数说明 参数 说明 所属项目 任务所属项目。 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。
query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个?,形式为参数名=参数取值。例如,limit=10表示查询不超过10条数据。