Help Center/ CodeArts Deploy/ API Reference/ APIs/ Deployment Record Measurement/ Obtaining the Success Rate of Deployed Applications in a Specified Application

Updated on 2023-11-28 GMT+08:00

View PDF

Obtaining the Success Rate of Deployed Applications in a Specified Application

Function

This API is used to obtain the application deployment success rate of a specified application.

URI

POST /v2/{project_id}/tasks/metrics/success-rate

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
start_date	Yes	String	Left boundary (included) of the application deployment start time. The format is yyyy-MM-dd.
end_date	Yes	String	Right boundary (included) of the application deployment start time. The format is YYYY-MM-DD. The maximum time range is one year.
task_ids	Yes	Array of strings	Task ID list.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
project_id	String	Project ID. For details, see Obtaining a Project ID.
project_name	String	Project name.
start_date	String	Left boundary (included) of the application deployment start time. The format is yyyy-MM-dd.
end_date	String	Right boundary (included) of the application deployment start time. The format is YYYY-MM-DD. The maximum time range is one year.
tasks_success_rate	Array of TaskSuccessRate objects	Application success rate list.

**Table 4** TaskSuccessRate
Parameter	Type	Description
task_id	String	Task ID.
task_name	String	Application name.
success_rate	String	Success rate.
record_count	Integer	Number of deployment records.
success_record_count	Integer	Number of successful deployment records.

Example Requests

https://{endpoint}/v2/89931e210b214b5892ea833712f0f5e0/tasks/metrics/success-rate

{
  "start_date" : "2022-01-01",
  "end_date" : "2022-10-26",
  "task_ids" : [ "5bf0a54f36b04ddda7b94470fee39307", "b6d20b703ffe4a04bc68790ddabf6ab7" ]
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "project_id" : "89931e210b214b5892ea833712f0f5e0",
  "project_name" : "Happy",
  "start_date" : "2022-01-01",
  "end_date" : "2022-10-26",
  "tasks_success_rate" : [ {
    "task_id" : "5bf0a54f36b04ddda7b94470fee39307",
    "task_name" : "happy482 Health Test via URLs",
    "success_rate" : "0",
    "record_count" : 8,
    "success_record_count" : 0
  }, {
    "task_id" : "b6d20b703ffe4a04bc68790ddabf6ab7",
    "task_name" : "happy486 Start/Stop Tomcat",
    "success_rate" : "14.29",
    "record_count" : 14,
    "success_record_count" : 2
  } ]
}