Help Center/ CodeArts Deploy/ API Reference/ APIs/ Application Management/ Querying the Historical Deployment Records of a Specified Application in a Project by the Start Time and End Time

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

View PDF

Querying the Historical Deployment Records of a Specified Application in a Project by the Start Time and End Time

Function

This API is used to query the historical deployment records of a specified application in a project based on the start time and end time.

URI

GET /v2/{project_id}/task/{id}/history

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID. Minimum: 32 Maximum: 32
id	Yes	String	Task ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page	Yes	Integer	Page number, indicating that the query starts from this page. The value of page is no less than 1.
size	Yes	Integer	Number of items displayed on each page. The value of size is no more than 100.
start_date	Yes	String	Start time. The format is YYYY-MM-DD. The time range cannot exceed 30 days.
end_date	Yes	String	End time. The format is YYYY-MM-DD. The time range cannot exceed 30 days.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 0 Maximum: 20000
Content-Type	Yes	String	Message body type (format). Possible values: application/json;charset=utf-8 application/json Default: application/json;charset=utf-8 Enumeration values: application/json;charset=utf-8 application/json

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	Array of ExecuteRecordV2Body objects	List of historical application deployment records.
total_num	Integer	Total number of historical application deployment records between the start time and end time.

**Table 5** ExecuteRecordV2Body
Parameter	Type	Description
duration	String	Deployment duration.
state	String	Application status.
operator	String	Operator username.
execution_id	String	Deployment record ID.
start_time	String	Start time of application deployment.
nickname	String	Operator alias.
end_time	String	End time of application deployment.
release_id	Long	Deployment record sequence number.
type	String	Type.

Example Requests

https://{endpoint}/v2/5ab1363a143f46aa9959a4a8c2616589/task/ad9c1d60282544d2b5a380ea22539cf1/history?page=2&size=2&start_date=2022-03-16&end_date=2022-04-15

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : [ {
    "duration" : "00:16:53",
    "state" : "succeeded",
    "type" : "install",
    "operator" : "devcloud_devcloud_l00490255_01",
    "execution_id" : "50f18ce454a64ea5a62a33d56617b831",
    "start_time" : "2022-04-15 15:03:24",
    "nickname" : "A-B Side Account",
    "end_time" : "2022-04-15 15:20:17",
    "release_id" : 20
  }, {
    "duration" : "00:15:31",
    "state" : "failed",
    "type" : "install",
    "operator" : "devcloud_devcloud_l00490255_01",
    "execution_id" : "f757fbe93d35494ba0ff73b34e2f79aa",
    "start_time" : "2022-04-15 15:03:15",
    "nickname" : "A-B Side Account",
    "end_time" : "2022-04-15 15:18:46",
    "release_id" : 19
  } ],
  "total_num" : 20
}