Querying Build Tasks in a Project

Function

This API is used to query build tasks in a project.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/jobs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition CodeArts project ID. For details about how to obtain the Constraints N/A. Range Use a 32-character string containing a mix of digits and letters. Default Value N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page_index	No	Integer	Details: Page number, indicating that the query starts from this page. Constraints: N/A Value Range: Only numbers that are 0 or greater can be used.
page_size	Yes	Integer	Details: Number of records displayed on each page. Constraints: N/A Value Range: Only numbers that are 100 or less can be used.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
jobs	Array of Job objects	Definition Task list. Range N/A.
total	Integer	Definition Total number of tasks. Range 0–2147483647

**Table 5** Job
Parameter	Type	Description
id	String	Definition Task ID. Range N/A.
job_name	String	Definition Task name. Range N/A.
job_creator	String	Definition Task creator. Range N/A.
user_name	String	Definition Username. Range N/A.
last_build_time	Number	Definition Last execution time. Range N/A.
health_score	Integer	Definition Health score. Range N/A.
source_code	String	Definition Code source. Range N/A.
last_build_status	String	Definition Last build status. Range N/A.
is_finished	Boolean	Definition Whether the task is completed. Range ● true: Completed. ● false: Not completed.
disabled	Boolean	Definition Whether the task is disabled. Range ● true: Disabled. ● false: Enabled.
favorite	Boolean	Definition Whether the task is favorited. Range ● true: Favorited. ● false: Unfavorited.
is_modify	Boolean	Definition Whether granted the permission for modifying the task. Range ● true: Granted the permission to modify the task. ● false: Not granted the permission to modify the task.
is_delete	Boolean	Definition Whether granted the permission for deleting the task. Range ● true: Granted the permission to delete the task. ● false: Not granted the permission to delete the task.
is_execute	Boolean	Definition Whether granted the permission for running the task. Range ● true: Granted the permission to run the task. ● false: Not granted the permission to run the task.
is_copy	Boolean	Definition Whether granted the permission for cloning the task. Range ● true: Granted the permission to clone the task. ● false: Not granted the permission to clone the task.
is_forbidden	Boolean	Definition Whether granted the permission for disabling the task. Range ● true: Granted the permission to disable the task. ● false: Not granted the permission to disable the task.
is_view	Boolean	Definition Whether granted the permission for viewing the task. Range ● true: Granted the permission to view the task. ● false: Not granted the permission to view the task.
task_id	String	Definition Task record ID. Range N/A.
last_build_user	String	Definition User who runs the last build. Range N/A.
code_branch	String	Definition Code branch. Range N/A.
commit_id	String	Definition Code commit ID. 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_time	Long	Definition Build time. Range N/A.
scm_web_url	String	Definition Code repository URL. Range N/A.
scm_type	String	Definition Code repository type. Range codehub, repo, or github.
repo_id	String	Definition Code repository ID. Range N/A.
commit_detail_url	String	Definition Address of code commit record (Code source: Repo). Range N/A.
build_number	String	Definition Build number. Range N/A.
build_project_id	String	Definition Build project ID. Range N/A.
build_type	String	Definition Build type. Options include build from a branch, tag, or commit. Range branch ,tag and commitId.
last_job_running_status	String	Definition Last build time. Range N/A.
last_build_user_id	String	Definition ID of the user who runs the last build. Range N/A.
project_permission_switch	Boolean	Definition Whether project permissions are used. Range ● true: The project permission switch is turned on. ● false: The project permission switch is turned off.

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Example Requests

GET https://{endpoint}/v3/6ecbc5bac7c8442fb3d2563d53c13582/jobs?page_index=1&page_size=10

Example Responses

Status code: 200

{
  "total" : 1,
  "jobs" : [ {
    "id" : "6d27a9dcac204fbe9f5aee88740de3d4",
    "job_name" : "APITest-V6-RepositoryHistory-hz0vwK",
    "job_creator" : "611d0654d317435495d559308e2aa800",
    "user_name" : "apitest",
    "last_build_time" : 1754360164000,
    "health_score" : 0,
    "source_code" : "codeci",
    "is_finished" : false,
    "disabled" : false,
    "favorite" : false,
    "is_modify" : true,
    "is_delete" : true,
    "is_execute" : true,
    "is_copy" : true,
    "is_forbidden" : true,
    "is_view" : true,
    "task_id" : "#20250805.1",
    "last_build_user" : "apitest",
    "code_branch" : "master",
    "commit_id" : "85e9fe58fa924f673a94b270bed4c21b40e4c57e",
    "trigger_type" : "Manual",
    "build_time" : 0,
    "scm_web_url" : "https://devcloud.xx-xxxx-xx.example.com/codehub/569802/home",
    "scm_type" : "codehub",
    "repo_id" : "569802",
    "commit_detail_url" : "https://devcloud.xx-xxxx-xx.example.com/codehub/569802/85e9fe58fa924f673a94b270bed4c21b40e4c57e/commitdetail",
    "build_number" : "1",
    "build_project_id" : "fc0c2b07-8f47-41ce-90bf-e96416954eef",
    "build_type" : "branch",
    "last_job_running_status" : "Running",
    "last_build_user_id" : "611d0654d317435495d559308e2aa800",
    "project_permission_switch" : false
  } ]
}