Help Center/ CodeArts Deploy/ API Reference (Ally Region)/ APIs/ Managing Applications/ Querying the Historical Deployment Records of a Specified Application in a Project by the Start Time and End Time
Updated on 2026-01-15 GMT+08:00
Online Debugging
CLI Examples
Share

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 by the start time and end time.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

Default value:

N/A

id

Yes

String

Parameter description:

Deployment application ID.

Constraints:

N/A

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

page

Yes

Integer

Parameter description:

Page number, which means the query starts from this page.

Constraints:

N/A

Value range:

1-99,999

Default value:

N/A

size

Yes

Integer

Parameter description:

Number of items displayed on each page.

Constraints:

N/A

Value range:

1-100

Default value:

N/A

start_date

Yes

String

Parameter description:

Start time. The value format is yyyy-MM-dd. For example, 2022-03-16.

Constraints:

This parameter is used together with end_date. The value of end_date must be later than or equal to the value of start_date. The time range cannot exceed 30 days.

Value range:

N/A

Default value:

N/A

end_date

Yes

String

Parameter description:

End time. The value format is yyyy-MM-dd. For example, 2022-04-15.

Constraints:

This parameter is used together with start_date. The value of end_date must be later than or equal to the value of start_date. The time range cannot exceed 30 days.

Value range:

N/A

Default value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used for.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

Content-Type

Yes

String

Definition:

Type (or format) of the message body.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

Array of ExecuteRecordV2Body objects

Parameter description:

List of historical application deployment records.

total_num

Integer

Parameter description:

Total number of historical application deployment records between the start time and end time.

Value range:

N/A
Table 5 ExecuteRecordV2Body

Parameter

Type

Description

duration

String

Definition:

Deployment duration. Format: HH:mm:ss.

Value range:

N/A.

state

String

Definition:

Last execution status of the application.

Value range:

  • abort: Deployment stopped.

  • failed: Deployment failed.

  • not_started: Execution canceled.

  • pending: Queuing.

  • running: Deployment in progress.

  • succeeded: Deployment succeeded.

operator

String

Parameter description:

Operator username.

Value range:

N/A

execution_id

String

Parameter description:

Deployment record ID.

Value range:

The value consists of 32 characters. Letters and digits are allowed.

start_time

String

Definition:

Start time of application deployment. Format: yyyy-MM-dd HH:mm:ss. Example: 2021-02-25 10:37:27.

Value range:

N/A.

nickname

String

Parameter description:

Operator nickname.

Value range:

N/A

end_time

String

Definition:

End time of application deployment. Format: yyyy-MM-dd HH:mm:ss. Example: 2021-02-25 10:37:27.

Value range:

N/A.

release_id

Long

Parameter description:

Deployment record sequence number.

Value range:

N/A

type

String

Definition:

Deployment type.

Value range:

  • install: Deployment execution.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

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
}

Status code: 400

Bad Request

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

Status code: 403

Forbidden

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

Status Codes

Status Code

Description

200

OK: The request is successful.

400

Bad Request

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Managing Applications