Obtaining the Application Deployment Success Rate in a Specified Application

Function

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

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A. Value range: 32 characters, including letters and digits. Default value: N/A.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
start_date	Yes	String	Definition: Start time. Format: yyyy-MM-dd. Example: 2022-03-16. Constraints: This parameter is used together with end_date. The value of end_date must be greater than or equal to that of start_date. The interval between the start time and end time cannot exceed 366 days. Value range: N/A. Default value: N/A.
end_date	Yes	String	Definition: End time. Format: yyyy-MM-dd. Example: 2022-04-15. Constraints: This parameter is used together with start_date. The value of end_date must be greater than or equal to that of start_date. The interval between the start time and end time cannot exceed 366 days. Value range: N/A. Default value: N/A.
task_ids	Yes	Array of strings	Definition: Task ID list. Constraints: N/A. Value range: 32 characters, including letters and digits. Default value: N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
project_id	String	Definition: Project ID. For details, see Obtaining a Project ID. Value range: 32 characters, including letters and digits.
project_name	String	Definition: Project name. Value range: 3 to 128 characters.
start_date	String	Definition: Left boundary (included) of the application deployment start time range. Format: yyyy-MM-dd. Example: 2022-10-26. Value range: N/A.
end_date	String	Definition: Right boundary (included) of the application deployment start time range. Format: yyyy-MM-dd. Example: 2022-10-26. Value range: N/A.
tasks_success_rate	Array of TaskSuccessRate objects	Definition: Application success rate list.

**Table 4** TaskSuccessRate
Parameter	Type	Description
task_id	String	Definition: Task ID. Value range: 32 characters, including letters and digits.
task_name	String	Definition: Application name. Value range: 3 to 128 characters, including letters, digits, underscores (_), and hyphens (-).
success_rate	String	Definition: Success rate (%). Value range: 0–100.
record_count	Integer	Definition: Number of queried application deployment records. Value range: N/A.
success_record_count	Integer	Definition: Number of successful application deployment records. Value range: N/A.

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 Through 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
  } ]
}