查看用户全部的构建任务列表
功能介绍
查看用户全部的构建任务列表。
调用方法
请参见如何调用API。
URI
GET /v1/job/list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page_index |
否 |
Integer |
参数解释: 分页页码, 表示从此页开始查询。 约束限制: 不涉及。 取值范围: 只能使用数字,大于等于0。 默认取值: 0 |
page_size |
否 |
Integer |
参数解释: 每页显示的条目数量。 约束限制: 正整数。 取值范围: page_size小于等于100。 默认取值: 10 |
search |
否 |
String |
参数解释: 查询过滤条件。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
sort_field |
否 |
String |
排序字段 |
sort_order |
否 |
String |
排序方式(ASC|DESC) |
creator_id |
否 |
String |
创建人 |
build_status |
否 |
String |
构建状态 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
参数解释: 返回结果。 取值范围: 不涉及。 |
status |
String |
参数解释: 返回状态信息。 取值范围: ● success:表示接口调用成功。 ● fail:表示接口调用失败。 |
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
参数解释: 任务总数。 取值范围: 不涉及。 |
job_list |
Array of job_list objects |
参数解释: 任务列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 任务ID。 取值范围: 不涉及。 |
job_name |
String |
参数解释: 任务名称。 取值范围: 不涉及。 |
job_creator |
String |
参数解释: 任务创建者。 取值范围: 不涉及。 |
user_id |
String |
参数解释: 用户id。 取值范围: 不涉及。 |
user_name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
nick_name |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
project_id |
String |
参数解释: CodeArts项目ID。构建任务所在项目的ID。 取值范围: 不涉及。 |
project_name |
String |
参数解释: 构建任务所在项目的名称。 取值范围: 不涉及。 |
last_build_time |
Number |
参数解释: 最新执行时间。 取值范围: 不涉及。 |
health_score |
Integer |
参数解释: 健康分值。 取值范围: 不涉及。 |
source_code |
String |
参数解释: 代码来源。 取值范围: 不涉及。 |
last_build_status |
String |
参数解释: 最新构建状态。 取值范围: 不涉及。 |
last_job_running_status |
String |
参数解释: 最新运行状态。 取值范围: 不涉及。 |
last_build_user |
String |
参数解释: 执行用户。 取值范围: 不涉及。 |
last_build_user_id |
String |
参数解释: 执行用户ID。 取值范围: 不涉及。 |
is_finished |
Boolean |
参数解释: 是否已结束。 取值范围: ● true:已结束。 ● false:未结束。 |
disabled |
Boolean |
参数解释: 是否已禁用。 取值范围: ● true:已禁用。 ● false:未禁用。 |
favorite |
Boolean |
参数解释: 是否已收藏。 取值范围: ● true:已收藏。 ● false:未收藏。 |
is_modify |
Boolean |
参数解释: 是否有修改任务权限。 取值范围: ● true:有修改任务权限。 ● false:没有修改任务权限。 |
is_delete |
Boolean |
参数解释: 是否有删除任务权限。 取值范围: ● true:有删除任务权限。 ● false:没有删除任务权限。 |
is_view |
Boolean |
参数解释: 是否有查看任务权限。 取值范围: ● true:有查看任务权限。 ● false:没有查看任务权限。 |
is_execute |
Boolean |
参数解释: 是否有执行任务权限。 取值范围: ● true:有执行任务权限。 ● false:没有执行任务权限。 |
is_copy |
Boolean |
参数解释: 是否有复制任务权限。 取值范围: ● true:有复制任务权限。 ● false:没有复制任务权限。 |
is_forbidden |
Boolean |
参数解释: 是否有禁用任务权限。 取值范围: ● true:有禁用任务权限。 ● false:没有禁用任务权限。 |
task_id |
String |
参数解释: 任务记录编号。 取值范围: 不涉及。 |
code_branch |
String |
参数解释: 代码分支。 取值范围: 不涉及。 |
commit_id |
String |
参数解释: 代码提交ID。 取值范围: 不涉及。 |
trigger_type |
String |
参数解释: 触发方式,可选值:手工触发(MANUAL),定时触发(TIMED_EXECUTION),代码更新触发(CODEHUB_TRIGGER),流水线触发(PIPELINE_TRIGGER)。 取值范围: ● MANUAL:手工触发。 ● TIMED_EXECUTION:定时触发。 ● CODEHUB_TRIGGER:代码更新触发。 ● PIPELINE_TRIGGER:流水线触发。 |
build_time |
Number |
参数解释: 执行时间。 取值范围: 不涉及。 |
scm_web_url |
String |
参数解释: 代码源地址。 取值范围: 不涉及。 |
scm_type |
String |
参数解释: 仓库类别。 取值范围: codehub、repo、github。 |
repo_id |
String |
参数解释: repo的id。 取值范围: 不涉及。 |
commit_detail_url |
String |
参数解释: 代码提交记录信息地址(代码源为Repo)。 取值范围: 不涉及。 |
build_number |
String |
参数解释: 构建编号。 取值范围: 不涉及。 |
forbidden_msg |
String |
参数解释: 禁用消息。 取值范围: 不涉及。 |
build_project_id |
String |
参数解释: 构建工程ID,唯一对应codeci_job_id。 取值范围: 不涉及。 |
build_type |
String |
参数解释: 构建类别。 取值范围: 不涉及。 |
tag |
String |
参数解释: 仓库tag。 取值范围: 不涉及。 |
project_permission_switch |
Boolean |
参数解释: 使用项目权限。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v1/job/list
响应示例
状态码: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测试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代码示例
SDK代码示例如下。
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)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
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)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。