Querying All Build Tasks
Function
This API is used to query all build tasks.
Calling Method
For details, see Calling APIs.
URI
GET /v1/job/list
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 |
No |
Integer |
Definition Number of items displayed on each page. Constraints The value is a positive integer. Range The value of page_size is no more than 100. |
search |
No |
String |
Definition Filter criteria. Constraints N/A. Range N/A. Default Value N/A. |
sort_field |
No |
String |
Sorting field. |
sort_order |
No |
String |
Sorting order (ASC or DESC). |
creator_id |
No |
String |
Creator. |
build_status |
No |
String |
Build status. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
result object |
Definition Returned result. Range N/A. |
status |
String |
Definition Returned status information. Range ● success: The API call is successful. ● fail: The API call failed. |
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Definition Total number of tasks. Range N/A. |
job_list |
Array of job_list objects |
Definition Task list. Range N/A. |
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_id |
String |
Definition User ID. Range N/A. |
user_name |
String |
Definition Username. Range N/A. |
nick_name |
String |
Definition User nickname. Range N/A. |
project_id |
String |
Definition CodeArts project ID. ID of the project to which the build task belongs. Range N/A. |
project_name |
String |
Definition Name of the project to which the build task belongs. 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. |
last_job_running_status |
String |
Definition The latest running status. Range N/A. |
last_build_user |
String |
Definition User who executes a build. Range N/A. |
last_build_user_id |
String |
Definition ID of the user who executes a build. 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_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. |
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. |
task_id |
String |
Definition Task record ID. 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 |
Number |
Definition Execution time. Range N/A. |
scm_web_url |
String |
Definition Code source address. Range N/A. |
scm_type |
String |
Definition Repository type. Range codehub, repo, or github. |
repo_id |
String |
Definition Repo 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. |
forbidden_msg |
String |
Definition Message of disabling tasks. Range N/A. |
build_project_id |
String |
Definition Build project ID. It uniquely corresponds to codeci_job_id. Range N/A. |
build_type |
String |
Definition Build type. Range N/A. |
tag |
String |
Definition Repository tag. Range N/A. |
project_permission_switch |
Boolean |
Definition Whether project permissions are used. Range N/A. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
GET https://{endpoint}/v1/job/list
Example Responses
Status code: 200
OK
{ "result" : { "total" : 20697, "job_list" : [ { "id" : "8f4fb54a55c744beb8967cf50d96d87b", "job_name" : "APITest-JobList-running-2kDRoU", "job_creator" : "ae22fd035f354cfa8d82a3f1c8940446", "user_id" : "ae22fd035f354cfa8d82a3f1c8940446", "user_name" : "testUser", "project_id" : "6823252f543d4915b49892a5fd9f0ec3", "project_name" : "CodeCIServer – API Test 01", "last_build_time" : 1727041445000, "health_score" : 0, "source_code" : "codeci", "last_build_status" : "aborted", "last_job_running_status" : "Finished", "last_build_user" : "testUser", "last_build_user_id" : "ae22fd035f354cfa8d82a3f1c8940446", "is_finished" : true, "disabled" : false, "favorite" : false, "is_modify" : true, "is_delete" : true, "is_execute" : true, "is_copy" : true, "is_forbidden" : true, "is_view" : true, "task_id" : "#20240923.1", "commit_id" : "", "trigger_type" : "Manual", "build_time" : 0, "scm_type" : "codehub", "repo_id" : "", "commit_detail_url" : "", "build_number" : "1", "forbidden_msg" : "", "build_project_id" : "8597a528-068e-4bfa-a812-3c625060c007", "project_permission_switch" : false } ] }, "status" : "success" }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsbuild.v3.region.CodeArtsBuildRegion; import com.huaweicloud.sdk.codeartsbuild.v3.*; import com.huaweicloud.sdk.codeartsbuild.v3.model.*; public class ListJobSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>")) .build(); ListJobRequest request = new ListJobRequest(); try { ListJobResponse response = client.listJob(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsbuild.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsBuildClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListJobRequest() response = client.list_job(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsbuild.NewCodeArtsBuildClient( codeartsbuild.CodeArtsBuildClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListJobRequest{} response, err := client.ListJob(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot