# 查询gitcode流水线运行记录 - ListActionsPipelineRuns #### 功能介绍 查询gitcode流水线运行记录 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-pipeline/pipeline_03_0006.html)。 #### URI POST /v6/{domain_id}/api/pac/pipelines/actions 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | **参数解释**： 租户ID，用户的domainId。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | page | 否 | Long | **参数解释**： 分页查询页码。 **约束限制**： 不涉及。 **取值范围**： 大于0。 **默认取值**： 不涉及。 | | page_size | 否 | String | **参数解释**： 每页的查询数量。 **约束限制**： 不涉及。 **取值范围**： 固定20。 **默认取值**： 不涉及。 | | https_url | 是 | String | **参数解释**： 代码源地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | pipeline_name | 否 | String | **参数解释**： 流水线名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | file_path | 否 | String | **参数解释**： 文件所处路径。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | pipeline_run_name | 否 | String | **参数解释**： 流水线运行人名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | event | 否 | String | **参数解释**： 流水线触发类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | actor | 否 | String | **参数解释**： 流水线创建者名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | branch | 否 | String | **参数解释**： 代码源分支。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | status | 否 | String | **参数解释**： 流水线运行状态。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | offset | 否 | Integer | **参数解释**： 查询偏移量。 **约束限制**： 大于等于0。 **取值范围**： 不涉及。 **默认取值**： 0。 | | limit | 否 | Integer | **参数解释**： 查询分页大小。 **约束限制**： 大于等于0。 **取值范围**： 不涉及。 **默认取值**： 10。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | offset | Integer | **参数解释**： 查询偏移量。 **约束限制**： 大于等于0。 **取值范围**： 不涉及。 **默认取值**： 0。 | | limit | Integer | **参数解释**： 查询分页大小。 **约束限制**： 大于等于0。 **取值范围**： 不涉及。 **默认取值**： 10。 | | total | Long | **参数解释**： 查询流水线总量。 **取值范围**： 不涉及。 | | success_times | Long | **参数解释**： 查询流水线运行成功数量。 **取值范围**： 不涉及。 | | failed_times | Long | **参数解释**： 查询流水线运行失败数量。 **取值范围**： 不涉及。 | | pipeline_runs | Array of [PipelineRunActions] objects | **参数解释**： 流水线运行记录。 **取值范围**： 不涉及。 | 表4PipelineRunActions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pipeline_id | String | **参数解释**： 流水线id。 **取值范围**： 不涉及。 | | pipeline_run_id | String | **参数解释**： 流水线运行实例id。 **取值范围**： 不涉及。 | | actor | String | **参数解释**： 流水线执行人。 **取值范围**： 不涉及。 | | pipeline_name | String | **参数解释**： 流水线名称。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 流水线运行状态。 **取值范围**： 不涉及。 | | run_number | String | **参数解释**： 流水线运行实例编号。 **取值范围**： 不涉及。 | | event | String | **参数解释**： 流水线触发类型。 **取值范围**： 不涉及。 | | branch | String | **参数解释**： 代码源分支。 **取值范围**： 不涉及。 | | start_time | String | **参数解释**： 流水线开始运行时间。 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 流水线结束运行时间。 **取值范围**： 不涉及。 | | commit_id | String | **参数解释**： 代码源提交记录。 **取值范围**： 40位字符。 | | pipeline_run_name | String | **参数解释**： 流水线运行人名称。 **取值范围**： 不涉及。 | | https_url | String | **参数解释**： 流水线链接。 **取值范围**： 不涉及。 | | file_path | String | **参数解释**： YAML文件路径。 **取值范围**： 不涉及。 | #### 请求示例 ``` POST https://{endpoint}/v6/93b9fc6ffc6a4edc9ab049c1f0dbec4b/api/pac/pipelines/actions { "offset" : 0, "limit" : 10, "https_url" : "https://example.com/pipeline/runs", "pipeline_name" : "MyPipeline", "file_path" : "/path/to/file", "pipeline_run_name" : "Run_2023_09_15", "event" : "push", "actor" : "username123", "branch" : "main", "status" : "success" } ``` #### 响应示例 **状态码：200** OK ``` { "total" : 100, "offset" : 0, "limit" : 10, "success_times" : 75, "failed_times" : 25, "pipeline_runs" : [ { "pipeline_id" : "pipeline_001", "pipeline_run_id" : "run_001", "actor" : "user123", "pipeline_name" : "Main Pipeline", "status" : "success", "run_number" : "1", "event" : "commit", "branch" : "main", "start_time" : "2023-09-15T12:00:00Z", "end_time" : "2023-09-15T12:30:00Z", "commit_id" : "abc123def456", "pipeline_run_name" : "Run on main branch", "https_url" : "https://example.com/pipeline/run/1", "file_path" : "/path/to/file" } ] } ``` #### 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.codeartspipeline.v2.region.CodeArtsPipelineRegion; import com.huaweicloud.sdk.codeartspipeline.v2.*; import com.huaweicloud.sdk.codeartspipeline.v2.model.*; public class ListActionsPipelineRunsSolution { 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); CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsPipelineRegion.valueOf("")) .build(); ListActionsPipelineRunsRequest request = new ListActionsPipelineRunsRequest(); request.withDomainId("{domain_id}"); ActionsPipelineRunsQueryDTO body = new ActionsPipelineRunsQueryDTO(); body.withStatus("success"); body.withBranch("main"); body.withActor("username123"); body.withEvent("push"); body.withPipelineRunName("Run_2023_09_15"); body.withFilePath("/path/to/file"); body.withPipelineName("MyPipeline"); body.withHttpsUrl("https://example.com/pipeline/runs"); request.withBody(body); try { ListActionsPipelineRunsResponse response = client.listActionsPipelineRuns(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 huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartspipeline.v2 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 = CodeArtsPipelineClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsPipelineRegion.value_of("")) \ .build() try: request = ListActionsPipelineRunsRequest() request.domain_id = "{domain_id}" request.body = ActionsPipelineRunsQueryDTO( status="success", branch="main", actor="username123", event="push", pipeline_run_name="Run_2023_09_15", file_path="/path/to/file", pipeline_name="MyPipeline", https_url="https://example.com/pipeline/runs" ) response = client.list_actions_pipeline_runs(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" codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/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 := codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartspipeline.NewCodeArtsPipelineClient(hcClient) request := &model.ListActionsPipelineRunsRequest{} request.DomainId = "{domain_id}" statusActionsPipelineRunsQueryDto:= "success" branchActionsPipelineRunsQueryDto:= "main" actorActionsPipelineRunsQueryDto:= "username123" eventActionsPipelineRunsQueryDto:= "push" pipelineRunNameActionsPipelineRunsQueryDto:= "Run_2023_09_15" filePathActionsPipelineRunsQueryDto:= "/path/to/file" pipelineNameActionsPipelineRunsQueryDto:= "MyPipeline" request.Body = &model.ActionsPipelineRunsQueryDto{ Status: &statusActionsPipelineRunsQueryDto, Branch: &branchActionsPipelineRunsQueryDto, Actor: &actorActionsPipelineRunsQueryDto, Event: &eventActionsPipelineRunsQueryDto, PipelineRunName: &pipelineRunNameActionsPipelineRunsQueryDto, FilePath: &filePathActionsPipelineRunsQueryDto, PipelineName: &pipelineNameActionsPipelineRunsQueryDto, HttpsUrl: "https://example.com/pipeline/runs", } response, err := client.ListActionsPipelineRuns(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsPipeline/sdk?api=ListActionsPipelineRuns)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pipeline/ErrorCode.html)。