根据任务类型获取检查列表 - ShowCheckList
功能介绍
根据分支、Tag、Cr、Mr等任务类型分别获取对应的检查列表。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
GET /v4/task/{task_id}/check-list
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释： 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
check_type |
否 |
String |
参数解释： 任务类型。 约束限制： 不涉及。 取值范围：
默认取值： branch。 |
|
page |
是 |
Integer |
参数解释： 分页页码。 约束限制： 不涉及。 取值范围:
默认取值： 不涉及。 |
|
page_size |
是 |
Integer |
参数解释： 分页大小。 约束限制： 不涉及。 取值范围：
默认取值： 200 |
|
search |
否 |
String |
参数解释： 搜索关键字。 约束限制： check_type为branch时支持搜索分支名； check_type为tag时支持搜索tag名； check_type为cr或mr时不支持搜索。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
time_start |
否 |
String |
参数解释： 检查开始时间的起点。使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。 约束限制： check_type为branch或tag时不支持时间过滤； check_type为cr或mr时支持时间过滤。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
time_end |
否 |
String |
参数解释： 检查开始时间的终点。使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。 约束限制： check_type为branch或tag时不支持时间过滤； check_type为cr或mr时支持时间过滤。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
CheckListResult object |
参数解释： 获取检查列表的响应结果。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释: 检查列表的总数。 取值范围: ≥0 |
|
list |
Array of CheckResultInfo objects |
参数解释： 检查详情。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
taskId |
String |
参数解释: 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即“查询任务列表接口”的响应中的ID字段。 取值范围: 字符串长度＞0。 |
|
branchName |
String |
参数解释: 分支名。 取值范围: 字符串长度＞0。 |
|
isDefault |
Boolean |
参数解释: 是否是默认分支。 取值范围: true、false。 |
|
status |
String |
参数解释: 任务执行状态。 取值范围:
|
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
查询任务ID为aeuxxlgh，分支为master的分支检查记录，分页为第1页，分页大小是每页10个。
GET https://{endpoint}/v4/task/aeuxxlgh/check-list?check_type=branch&page=1&page_size=10&search=master
响应示例
状态码：200
Request succeeded!
{
"result" : {
"total" : 3,
"list" : [ {
"taskId" : null,
"branchName" : "dev",
"isDefault" : false,
"status" : null
}, {
"taskId" : "63f5fb89cc9a4855967947935b74cd61",
"branchName" : "master",
"isDefault" : true,
"status" : "success"
}, {
"taskId" : null,
"branchName" : "test",
"isDefault" : false,
"status" : null
} ]
}
}
状态码：400
Bad Request
{
"error_code" : "CC.00000000",
"error_msg" : "网络繁忙，请稍后再试"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
