查看项目下用户的构建任务列表
功能介绍
查看项目下用户的构建任务列表。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: CodeArts项目ID。获取方式请参考获取CodeArts项目ID。 约束限制: 不涉及。 取值范围: 32位数字、字母组合的字符串。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page_index |
否 |
Integer |
参数解释: 分页页码, 表示从此页开始查询。 约束限制: 不涉及。 取值范围: 只能使用数字,大于等于0。 默认取值: 0 |
page_size |
是 |
Integer |
参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: 只能使用数字,小于等于100。 默认取值: 0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
jobs |
Array of Job objects |
参数解释: 任务列表。 取值范围: 不涉及。 |
total |
Integer |
参数解释: 任务总数。 取值范围: 0-2147483647 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 任务ID。 取值范围: 不涉及。 |
job_name |
String |
参数解释: 任务名称。 取值范围: 不涉及。 |
job_creator |
String |
参数解释: 任务创建者。 取值范围: 不涉及。 |
user_name |
String |
参数解释: 用户名称。 取值范围: 不涉及。 |
last_build_time |
Number |
参数解释: 最新执行时间。 取值范围: 不涉及。 |
health_score |
Integer |
参数解释: 健康分值。 取值范围: 不涉及。 |
source_code |
String |
参数解释: 代码来源。 取值范围: 不涉及。 |
last_build_status |
String |
参数解释: 最新构建状态。 取值范围: 不涉及。 |
is_finished |
Boolean |
参数解释: 是否已结束。 取值范围: ● true:表示已结束。 ● false:表示未结束。 |
disabled |
Boolean |
参数解释: 是否已禁用。 取值范围: ● true:表示已禁用。 ● false:表示未禁用。 |
favorite |
Boolean |
参数解释: 是否已收藏。 取值范围: ● true:表示已收藏。 ● false:表示未收藏。 |
is_modify |
Boolean |
参数解释: 是否有修改任务权限。 取值范围: ● true:表示有修改任务权限。 ● false:表示没有修改任务权限。 |
is_delete |
Boolean |
参数解释: 是否有删除任务权限。 取值范围: ● true:表示有删除任务权限。 ● false:表示没有删除任务权限。 |
is_execute |
Boolean |
参数解释: 是否有执行任务权限。 取值范围: ● true:表示有执行任务权限。 ● false:表示没有执行任务权限。 |
is_copy |
Boolean |
参数解释: 是否有复制任务权限。 取值范围: ● true:表示有复制任务权限。 ● false:表示没有复制任务权限。 |
is_forbidden |
Boolean |
参数解释: 是否有禁用任务权限。 取值范围: ● true:表示有禁用任务权限。 ● false:表示没有禁用任务权限。 |
is_view |
Boolean |
参数解释: 是否有查看任务权限。 取值范围: ● true:表示有查看任务权限。 ● false:表示没有查看任务权限。 |
last_build_user |
String |
参数解释: 最后一次构建用户。 取值范围: 不涉及。 |
trigger_type |
String |
参数解释: 触发方式,可选值:手工触发(MANUAL),定时触发(TIMED_EXECUTION),代码更新触发(CODEHUB_TRIGGER),流水线触发(PIPELINE_TRIGGER)。 取值范围: ● MANUAL:手工触发。 ● TIMED_EXECUTION:定时触发。 ● CODEHUB_TRIGGER:代码更新触发。 ● PIPELINE_TRIGGER:流水线触发。 |
build_time |
Long |
参数解释: 构建时间。 取值范围: 不涉及。 |
scm_web_url |
String |
参数解释: 代码仓web地址。 取值范围: 不涉及。 |
scm_type |
String |
参数解释: 代码仓类型。 取值范围: codehub、repo、github。 |
repo_id |
String |
参数解释: 代码仓ID。 取值范围: 不涉及。 |
build_project_id |
String |
参数解释: 构建项目ID。 取值范围: 不涉及。 |
last_job_running_status |
String |
参数解释: 最后一次构建时间。 取值范围: 不涉及。 |
last_build_user_id |
String |
参数解释: 最后一次构建用户ID。 取值范围: 不涉及。 |
状态码: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}/v3/6ecbc5bac7c8442fb3d2563d53c13582/jobs?page_index=1&page_size=10
响应示例
状态码:200
OK
{ "total" : 1, "jobs" : [ { "id" : "2a86c3c1ed18416399279fe6........", "job_name" : "demo", "job_creator" : "ae22fd035f354cfa8d82a3f1........", "user_name" : "test", "last_build_time" : 1608004535000, "health_score" : 75, "source_code" : "test", "last_build_status" : "blue", "is_finished" : true, "disabled" : true, "favorite" : true, "is_modify" : true, "is_delete" : true, "is_execute" : true, "is_copy" : true, "is_forbidden" : true, "is_view" : true } ] }
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 46 |
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 ShowJobListByProjectIdSolution { 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(); ShowJobListByProjectIdRequest request = new ShowJobListByProjectIdRequest(); request.withProjectId("{project_id}"); try { ShowJobListByProjectIdResponse response = client.showJobListByProjectId(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 31 |
# 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 = ShowJobListByProjectIdRequest() request.project_id = "{project_id}" response = client.show_job_list_by_project_id(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 36 |
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.ShowJobListByProjectIdRequest{} request.ProjectId = "{project_id}" response, err := client.ShowJobListByProjectId(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 |
错误码
请参见错误码。