文档首页/ 部署 CodeArts Deploy/ API参考（联盟区域）/ API/ 部署记录度量/ 获取指定项目的应用部署成功率
更新时间：2025-12-25 GMT+08:00
在线调试
CLI示例
分享

获取指定项目的应用部署成功率

功能介绍

获取指定项目的应用部署成功率。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/metrics/success-rate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目id，获取方式请参见获取项目id。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

start_date

是

String

参数解释：

部署应用开始时间范围的左边界（包含）。格式为yyyy-MM-dd。例如：2022-01-01。

约束限制：

与end_date配合使用，end_date需大于等于start_date，且最大时间范围为1年。

取值范围：

不涉及。

默认取值：

不涉及。

end_date

是

String

参数解释：

部署应用开始时间范围的右边界（包含）。格式为yyyy-MM-dd。例如：2022-10-26。

约束限制：

与start_date配合使用，end_date需大于等于start_date，且最大时间范围为1年。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

success_rate

String

参数解释：

成功率，单位%。

取值范围：

0-100。

project_id

String

参数解释：

项目id，获取方式请参见获取项目id。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

project_name

String

参数解释：

项目名称。

取值范围：

长度为[3,128]个字符。

start_date

String

参数解释：

部署应用开始时间范围的左边界（包含）。格式为yyyy-MM-dd。例如：2022-10-26。

取值范围：

不涉及。

end_date

String

参数解释：

部署应用开始时间范围的右边界（包含）。格式为yyyy-MM-dd。例如：2022-10-26。

取值范围：

不涉及。

task_count

Integer

参数解释：

查询到的应用数。

取值范围：

不涉及。

record_count

Integer

参数解释：

查询到的应用部署记录数。

取值范围：

不涉及。

success_record_count

Integer

参数解释：

成功的应用部署记录数。

取值范围：

不涉及。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

获取目标应用在指定时间段的部署成功率。

https://{endpoint}/v2/89931e210b214b5892ea833712f0f5e0/metrics/success-rate?start_date=2022-01-01&end_date=2022-10-26

响应示例

状态码：200

OK 请求响应成功

{
  "success_rate" : "34.09",
  "project_id" : "89931e210b214b5892ea833712f0f5e0",
  "project_name" : "Happy",
  "start_date" : "2022-01-01",
  "end_date" : "2022-10-26",
  "task_count" : 8,
  "record_count" : 44,
  "success_record_count" : 15
}

状态码：400

Bad Request

{
  "error_code" : "Deploy.00015002",
  "error_msg" : "Invalid request parameter."
}

状态码：403

Forbidden

{
  "error_code" : "Deploy.00011154",
  "error_msg" : "You do not have permissions to perform this operation."
}

状态码

状态码

描述

200

OK 请求响应成功

400

Bad Request

403

Forbidden

错误码

请参见错误码。

父主题： 部署记录度量