获取流水线的关联的任务列表
功能介绍
获取流水线的关联的任务列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/pipelines/{pipeline_id}/jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
pipeline_id |
是 |
Integer |
参数解释: 流水线 id。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Total |
String |
参数解释: 当前请求的结果总条数。 |
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of JobWithStageDto objects |
任务带阶段信息 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
任务ID 取值范围: 1-2147483647 |
sha |
String |
提交ID |
ref |
String |
分支 |
status |
String |
阶段状态, pending为排队,running为运行中,success为成功,failed为失败,canceled为取消,skipped为跳过,timedout为超时 枚举值:
|
name |
String |
任务名称 |
target_url |
String |
任务链接 |
created_at |
String |
创建时间 |
updated_at |
String |
更新时间 |
started_at |
String |
开始时间 |
finished_at |
String |
结束时间 |
third_build_id |
String |
任务在构建系统中的ID |
stage_id |
Integer |
阶段ID 取值范围: 1-2147483647 |
stage |
String |
阶段名称 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/repositories/2111976239/pipelines/6/jobs
响应示例
状态码:200
OK
[ { "id" : 31930, "sha" : "1c46c505c84853887efe2ea9ea02a1333bae2237", "ref" : "dev", "status" : "success", "name" : "任务1", "target_url" : "https://example.com/cicd/project/72271b5446614062a01b8be944c9f372/pipeline/detail/724cb378007d4303b91f85161f67d6b0/c9cfdc8b918e44c09ad1cdd8c6b13c78\"", "created_at" : "2025-05-17T11:02:25.000+08:00", "started_at" : "2025-05-17T11:02:25.000+08:00", "finished_at" : "2025-05-17T11:02:56.000+08:00", "updated_at\"" : "2025-05-17T11:02:56.000+08:00", "third_build_id" : "0ede266890ddd33cff76da30090b9780", "stage_id" : 123, "stage" : "external" } ]
状态码:401
Unauthorized
{ "error_code" : "CH.00000002", "error_msg" : "认证信息无法识别" }
状态码:404
Not Found
{ "error_code" : "CH.00402000", "error_msg" : "该仓库不存在,请检查后重试。" }
SDK代码示例
SDK代码示例如下。
Java
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 47 |
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.codehub.v4.region.CodeHubRegion; import com.huaweicloud.sdk.codehub.v4.*; import com.huaweicloud.sdk.codehub.v4.model.*; public class ListPipelineJobsSolution { 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); CodeHubClient client = CodeHubClient.newBuilder() .withCredential(auth) .withRegion(CodeHubRegion.valueOf("<YOUR REGION>")) .build(); ListPipelineJobsRequest request = new ListPipelineJobsRequest(); request.withRepositoryId({repository_id}); request.withPipelineId({pipeline_id}); try { ListPipelineJobsResponse response = client.listPipelineJobs(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()); } } } |
Python
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodehub.v4.region.codehub_region import CodeHubRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodehub.v4 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 = CodeHubClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPipelineJobsRequest() request.repository_id = {repository_id} request.pipeline_id = {pipeline_id} response = client.list_pipeline_jobs(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/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 := codehub.NewCodeHubClient( codehub.CodeHubClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPipelineJobsRequest{} request.RepositoryId = int32({repository_id}) request.PipelineId = int32({pipeline_id}) response, err := client.ListPipelineJobs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
404 |
Not Found |
错误码
请参见错误码。