-
获取账号ID - 代码检查 CodeArts Check
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
-
获取项目ID - 代码检查 CodeArts Check
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
-
查看规则集的规则列表 - 代码检查 CodeArts Check
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200
-
查询任务规则集的检查参数v2 - 代码检查 CodeArts Check
ruleset_id 是 String 规则集ID 表2 Query参数 参数 是否必选 参数类型 描述 language 是 String 规则集语言 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 设置媒体类型和编码格式
-
查询任务规则集的检查参数v3 - 代码检查 CodeArts Check
请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000
-
查询cmertrics缺陷概要 - 代码检查 CodeArts Check
String 项目ID task_id 是 String 任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1
-
查询任务检查失败日志 - 代码检查 CodeArts Check
task_id 是 String 任务ID 表2 Query参数 参数 是否必选 参数类型 描述 execute_id 否 String 任务单次的执行ID 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 设置媒体类型和编码格式
-
查询任务的高级选项 - 代码检查 CodeArts Check
请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000
-
历史扫描结果查询 - 代码检查 CodeArts Check
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200
-
任务配置屏蔽目录 - 代码检查 CodeArts Check
X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 Content-Type 是 String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型
-
查询规则集列表 - 代码检查 CodeArts Check
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200
-
设置每个项目对应语言的默认规则集配置 - 代码检查 CodeArts Check
规则集语言 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 400
-
查询缺陷详情的统计 - 代码检查 CodeArts Check
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表3 响应Body参数
-
任务配置检查参数 - 代码检查 CodeArts Check
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 Content-Type 是 String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型 描述 check_id 是 Integer
-
查询任务的已选规则集列表v2 - 代码检查 CodeArts Check
参数 是否必选 参数类型 描述 Content-Type 否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000
-
查询缺陷详情 - 代码检查 CodeArts Check
严重级别,0致命,1严重,2一般,3提示 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200
-
查询任务的已选规则集列表v3 - 代码检查 CodeArts Check
请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000
-
任务配置高级选项 - 代码检查 CodeArts Check
X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 Content-Type 是 String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型
-
终止检查任务 - 代码检查 CodeArts Check
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型
-
查询任务列表 - 代码检查 CodeArts Check
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200