# 获取合并请求关联的最新流水线 - ShowActualHeadPipeline #### 功能介绍 获取合并请求关联的最新流水线 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/doc?api=ShowActualHeadPipeline&version=v4)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codeartsrepo/codeartsrepo_05_0036.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsrepo:repository:getRepository | Read | - | - | - | - | #### URI GET /v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/actual-head-pipeline 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | repository_id | 是 | Integer | **参数解释：** 仓库的ID，通过[查询用户所有仓库](https://support.huaweicloud.com/api-codeartsrepo/ListUserAllRepositories.html)接口查询项目列表获取。 **约束限制：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | | merge_request_iid | 是 | Integer | **参数解释：** 合并请求 iid。 **取值范围：** 1\~2147483647 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [PipelineDetailDto] object | 流水线详情 | | is_valid | Boolean | 最新的commit是否有对应的流水线 | 表4PipelineDetailDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | 流水线ID **取值范围：** 1\~2147483647 | | web_url | String | 流水线链接 | | sha | String | commit id | | ref | String | 分支 | | status | String | 流水线状态，pending为排队，running为运行中，success为成功，failed为失败，canceled为取消，skipped为跳过，timedout为超时 | | created_at | String | 流水线创建时间 | | updated_at | String | 流水线更新时间 | | started_at | String | 流水线开始时间 | | finished_at | String | 流水线结束时间 | | repository_id | Integer | 仓库ID **取值范围：** 1\~2147483647 | | is_invalid | Boolean | 流水线是否失效 | | type | String | 流水线类型，MERGE REQUEST代表为合并请求触发的流水线 | | stages | Array of [PipelineStageDto] objects | 阶段信息 | | is_latest | Boolean | 是否是最近一条流水线 | | trigger_user | String | 触发的用户 | | all_job_finished | Boolean | 是否所有job都运行完成 | 表5PipelineStageDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | 阶段ID **取值范围：** 1\~2147483647 | | repository_id | Integer | 仓库ID **取值范围：** 1\~2147483647 | | pipeline_id | Integer | 流水线ID **取值范围：** 1\~2147483647 | | name | String | 阶段名称 | | sort_id | Integer | 阶段顺序id **取值范围：** 1\~2147483647 | | status | String | 阶段状态, pending为排队，running为运行中，success为成功，failed为失败，canceled为取消，skipped为跳过，timedout为超时 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 | | error_msg | String | **参数解释：** 错误信息。 | **状态码：404** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 | | error_msg | String | **参数解释：** 错误信息。 | #### 请求示例 ``` /v4/repositories/2111976239/merge-requests/6/actual-head-pipeline ``` #### 响应示例 **状态码：200** OK ``` { "is_valid" : true, "data" : { "id" : 8125, "web_url" : "https://example.com/72271b5446614062a01b8be944c9f372/hxb11222/pipelines/8125", "sha" : "5167228a3d13f9d59f969104c6fc4dbb38f7b5cc", "ref" : "master", "status" : "failed", "created_at" : "2024-12-12T20:47:46.000+08:00", "updated_at" : "2024-12-12T20:47:47.000+08:00", "started_at" : "2024-12-12T20:47:47.000+08:00", "finished_at" : "2024-12-12T20:47:47.000+08:00", "repository_id" : 2111976239, "is_invalid" : null, "type" : "MERGE REQUEST", "stages" : [ { "id" : 12625, "repository_id" : 2111976239, "pipeline_id" : 8125, "name" : "CodeArtsCheck", "sort_id" : null, "status" : "failed" } ], "is_latest" : true, "trigger_user" : null, "all_job_finished" : true } } ``` **状态码：401** Unauthorized ``` { "error_code" : "CH.00000002", "error_msg" : "认证信息无法识别" } ``` **状态码：404** Not Found ``` { "error_code" : "CH.00402000", "error_msg" : "该仓库不存在,请检查后重试。" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` 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.codeartsrepo.v4.region.CodeArtsRepoRegion; import com.huaweicloud.sdk.codeartsrepo.v4.*; import com.huaweicloud.sdk.codeartsrepo.v4.model.*; public class ShowActualHeadPipelineSolution { 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); CodeArtsRepoClient client = CodeArtsRepoClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsRepoRegion.valueOf("")) .build(); ShowActualHeadPipelineRequest request = new ShowActualHeadPipelineRequest(); request.withRepositoryId({repository_id}); request.withMergeRequestIid({merge_request_iid}); try { ShowActualHeadPipelineResponse response = client.showActualHeadPipeline(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 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsrepo.v4.region.codeartsrepo_region import CodeArtsRepoRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsrepo.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 = CodeArtsRepoClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsRepoRegion.value_of("")) \ .build() try: request = ShowActualHeadPipelineRequest() request.repository_id = {repository_id} request.merge_request_iid = {merge_request_iid} response = client.show_actual_head_pipeline(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 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsrepo "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartsrepo.CodeArtsRepoClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartsrepo.NewCodeArtsRepoClient(hcClient) request := &model.ShowActualHeadPipelineRequest{} request.RepositoryId = int32({repository_id}) request.MergeRequestIid = int32({merge_request_iid}) response, err := client.ShowActualHeadPipeline(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/sdk?api=ShowActualHeadPipeline&version=v4)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 401 | Unauthorized | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeartsrepo/ErrorCode.html)。