Obtaining Build Record Information (Version 4)

Function

This API is used to obtain build record information.

Calling Method

For details, see Calling APIs.

URI

GET /v4/jobs/{job_id}/{build_no}/record-info

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
job_id	Yes	String	Definition Enter the ID of the build task whose history you want to query. To obtain this ID, open the build task details page in your browser, and copy the 32-character string, which includes both digits and letters, at the end of the URL. Constraints N/A. Range The value is 32 characters long. Only letters and digits are allowed. Default Value N/A.
build_no	Yes	Integer	Definition The build number tracks each run of the build task. This parameter starts at 1, indicating the first build. It increments by 1 for every subsequent run. Constraints The value is a positive integer. Range Use only numbers that are 1 or greater. Default Value 1

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. Constraints Global tenant tokens are not supported. Use a region-level token whose scope is project. Range N/A. Default Value N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
status	String	Definition API response status. Range ● success: The API call is successful. ● fail: The API call failed.
error	Object	Definition Error message. Range N/A.
result	result object	Definition Data returned after the API is successfully called. Range N/A.

**Table 4** result
Parameter	Type	Description
id	String	Definition ID. Range N/A.
build_project_id	String	Definition Build project ID. It uniquely corresponds to codeci_job_id. Range N/A.
build_record_id	String	Definition Build record ID. Range N/A.
parent_record_id	String	Definition Parent build record ID. Range N/A.
devcloud_project_id	String	Definition Project ID. Range N/A.
codeci_job_id	String	Definition codeci task ID. It uniquely corresponds to build_project_id. Range N/A.
user_id	String	Definition User ID. Range N/A.
build_no	Integer	Definition Build number. Range N/A.
daily_build_num	String	Definition Daily build number. It starts from 1 every day. Range N/A.
execution_id	String	Definition CloudOctopus task ID. Range N/A.
repo_name	String	Definition Code repository name. Range N/A.
repo_id	String	Definition Code repository ID. Range N/A.
branch	String	Definition Name of the code repository branch. Range N/A.
tag	String	Definition Code repository tag. Range N/A.
commit	String	Definition Commit ID of a code repository. Range N/A.
commit_message	String	Definition Commit message for a repository. Range N/A.
commit_create_time	String	Definition Commit creation time. Range N/A.
trigger_type	String	Definition Triggering mode. Options include MANUAL (manual execution), TIMED_EXECUTION (schedule), CODEHUB_TRIGGER (code change), or PIPELINE_TRIGGER (pipeline). Range ● MANUAL: Manual trigger ● TIMED_EXECUTION: Scheduled trigger ● CODEHUB_TRIGGER: Code change trigger ● PIPELINE_TRIGGER: Pipeline trigger
build_type	String	Definition Build type. Range N/A.
status	String	Definition Build status. Range N/A.
domain_id	String	Definition Tenant ID. Range N/A.
create_time	String	Definition Task creation time. Range N/A.
schedule_time	String	Definition Build assignment time. Range N/A.
queued_time	String	Definition Build queuing duration. Range N/A.
start_time	String	Definition Build start time. Range N/A.
runnable_time	String	Definition Time when CloudOctopus starts the build process. Range N/A.
finish_time	String	Definition Build end time. Range N/A.
duration	Integer	Definition Build duration. Range N/A.
record_status	String	Definition Record status. Range N/A.
use_private_slave	Integer	Definition Whether a custom executor is used. Range N/A.
region	String	Definition The region where the tenant is located. Range N/A.
err_msg	String	Definition Error message. Range N/A.
build_config_type	String	Definition Build configuration type. It can be YAML or ACTION. Range YAML or ACTION.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

GET https://{endpoint}/v4/jobs/cb5fa20de5fd4cf8be681d4bd6fdd2f6/61/record-info

Example Responses

Status code: 200

{
  "status" : "success",
  "result" : {
    "id" : "eb9d73c7-61b3-4823-b476-a7c00c493b8a",
    "build_project_id" : "31581e9f-5772-4053-a50c-d5690578c8fd",
    "build_record_id" : "9d6169b9-022d-458c-9dc8-48cc94cc4083",
    "parent_record_id" : null,
    "devcloud_project_id" : "b4d3971c3988463b865f6f920846149e",
    "codeci_job_id" : "68491d9bc97b4774adb93e29b46d2dc6",
    "user_id" : "ae22fd035f354cfa8d82a3f1c8940446",
    "build_no" : 532,
    "daily_build_num" : "20221011.29",
    "execution_id" : "j_YE1bu9Z7",
    "repo_name" : "maven",
    "repo_id" : "2111616838",
    "branch" : "buildflow_env",
    "tag" : null,
    "commit" : null,
    "commit_message" : null,
    "commit_create_time" : "2022-10-11T08:28:42.000+00:00",
    "trigger_type" : "MANUAL",
    "build_type" : "branch",
    "status" : "SUCCESS",
    "domain_id" : "60021bab32fd450aa2cb89226f425e06",
    "create_time" : "2022-10-11T08:28:42.000+00:00",
    "schedule_time" : "2022-10-11T08:28:45.000+00:00",
    "queued_time" : "2022-10-11T08:28:45.000+00:00",
    "start_time" : "2022-10-11T08:28:47.000+00:00",
    "runnable_time" : "2022-10-11T08:16:04.000+00:00",
    "finish_time" : "2022-10-11T08:30:27.000+00:00",
    "duration" : 100068,
    "record_status" : null,
    "use_private_slave" : 0,
    "region" : "xx-xxxx-xx",
    "err_msg" : null,
    "build_config_type" : "YAML"
  }
}