Help Center/ CodeArts Build/ API Reference/ Task APIs/ View the build task build history list based on the start time and end time.

Updated on 2023-12-06 GMT+08:00

View PDF

View the build task build history list based on the start time and end time.

Function

Calling Method

For details, see Calling APIs.

URI

GET /v3/jobs/{job_id}/period-history

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
job_id	Yes	String	Indicates the ID of the build task. The value is a string of 32 characters consisting of digits and letters at the end of the browser URL when you edit the build task file.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	Indicates the page number from which the query starts. The value of offset is greater than or equal to 0.
limit	Yes	Integer	Specifies the number of items displayed on each page. The value of limit is less than or equal to 100.
start_time	Yes	String	Start time of a time range. The format is yyyy-MM-dd. The interval between the start time and end time cannot exceed 30 days.
end_time	Yes	String	End time of a time range. The format is yyyy-MM-dd. The interval between the start time and end time cannot exceed 30 days.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Obtain the value by calling the IAM service interface. (value of X-Subject-Token in the response header). Global tenant tokens are not supported. Use a region-level token whose scope is project.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	By path limit
history_records	Array of history_records objects	Build History List

**Table 5** history_records
Parameter	Type	Description
record_id	String	Build record ID, which is a unique key.
job_id	String	Task ID.
build_number	Integer	Build ID
start_time	String	Start time of the build.
end_time	String	End time of the build.
result	String	Build Results
branch	String	Branch
commit_id	String	Commit ID for code submission.
commit_message	String	Submission information entered by a user during code submission. This parameter is valid only when the Repo repository is used.
executor	String	Name of the user who runs the build task script.
trigger_type	String	Triggering mode. The options are as follows: manual triggering, scheduled triggering, code update triggering, and pipeline triggering.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Example Requests

GET https://{endpoint}/v3/jobs/{job_id}/period-history?start_time=2021-01-04&end_time=2021-01-14&offset=0&limit=10

Example Responses

Status code: 200

{
  "total" : 1,
  "history_records" : {
    "record_id" : "20201230.1",
    "job_id" : "f9d6c8466d614a9788e9a0acf6c15f46",
    "build_number" : 55,
    "start_time" : "2020-12-30T17:33:11+08:00",
    "end_time" : "2020-12-30T17:33:27+08:00",
    "result" : "FAILURE",
    "branch" : "master",
    "commit_id" : "2f37dd494927d2c6259417c58e5faeb72bfe7150",
    "commit_message" : "test",
    "executor" : "test",
    "trigger_type" : "Manual triggering"
  }
}