文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 获取覆盖率接口
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取覆盖率接口

功能介绍

获取覆盖率接口

调用方法

请参见如何调用API。

URI

GET /v1/report/{job_id}/summary

表1 路径参数

参数

是否必选

参数类型

描述

job_id

是

String

构建的任务ID；

编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。
表2 Query参数

参数

是否必选

参数类型

描述

build_no

是

Integer

构建任务的构建编号，从1开始，每次构建递增1

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

状态

error

Object

错误

result

result object

结果
表4 result

参数

参数类型

描述

summary

ShowReportSummary object

单元测试报告

sub_summarys

Array of ShowReportSummary objects

单元测试报告列表
表5 ShowReportSummary

参数

参数类型

描述

job_id

String

任务编号

build_no

Integer

构建编号

stage_name

String

步骤名称，对应构建步骤，例如stage2为代码检出

root_id

String

报告编号

total

Integer

总数

success

Integer

成功数量

failures

Integer

失败数量

errors

Integer

错误数量

others

Integer

其他

success_density

String

构建时长

execution_time

String

执行耗时

genrate_time

String

生成时间

region

String

局点

is_success

String

是否通过

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/report/48c66c6002964721be537cdc6ce0297b/summary

响应示例

状态码： 200

OK

{
  "result" : {
    "summary" : {
      "job_id" : "c798139500d2456d82d95d108f182b5a",
      "build_no" : 1,
      "stage_name" : "stage3",
      "root_id" : "025fa618-a241-4219-87b5-e0e2b0ce0c89",
      "total" : 1,
      "success" : 1,
      "failures" : 0,
      "errors" : 0,
      "others" : 0,
      "success_density" : 1,
      "execution_time" : 8602,
      "genrate_time" : "2024-09-20T06:41:03.000+00:00",
      "region" : "cn-north-7",
      "is_success" : true
    },
    "sub_summarys" : [ {
      "job_id" : "c798139500d2456d82d95d108f182b5a",
      "build_no" : 1,
      "stage_name" : "stage3",
      "root_id" : "e3dc82de-597b-46e4-98e7-7b55652184de",
      "total" : 1,
      "success" : 1,
      "failures" : 0,
      "errors" : 0,
      "others" : 0,
      "success_density" : 1,
      "execution_time" : 8602,
      "genrate_time" : "2024-09-20T06:41:03.000+00:00",
      "region" : "cn-north-7",
      "is_success" : true
    } ]
  },
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档