文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 获取流水线步骤执行输出
更新时间:2024-11-29 GMT+08:00
分享

获取流水线步骤执行输出

功能介绍

获取流水线步骤执行输出

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/steps/outputs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

CodeArts项目ID。

约束限制

不涉及

取值范围

32位字符。

默认取值

不涉及。

pipeline_id

String

参数解释

流水线ID。

约束限制

不涉及

取值范围

32位字符。

默认取值

不涉及。

pipeline_run_id

String

参数解释

流水线运行实例ID。

约束限制

不涉及

取值范围

32位字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

step_run_ids

String

参数解释

流水线步骤ID。

约束限制

不涉及。

取值范围

每个ID为32位字符,仅由数字和字母组成。

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

step_outputs

Array of step_outputs objects

参数解释

步骤输出列表,记录每个步骤输出的ID和结果信息。

约束限制

不涉及。

current_system_time

Long

参数解释

当前系统时间。

取值范围

不涉及。

表5 step_outputs

参数

参数类型

描述

step_run_id

String

参数解释

步骤ID。

取值范围

32位字符。

output_result

Array of output_result objects

参数解释

步骤输出。

取值范围

不涉及。

表6 output_result

参数

参数类型

描述

key

String

参数解释

步骤输出key值。

取值范围

不涉及。

value

String

参数解释

步骤输出value值。

取值范围

不涉及。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

请求示例

https://{endpoint}/v5/26726a24b3f247b4b49300b6f84fee61/pipelines/5f58d4f7b0a9450a889c3ccb58813f1c/pipeline-runs/9018898842af45b3a0546f9caa44e4d5/steps/outputs?step_run_ids=eafeade4aade49b2bc1cac8405c2f44c

响应示例

状态码: 200

OK

{
  "step_outputs" : [ {
    "step_run_id" : "eafeade4aade49b2bc1cac8405c2f44c",
    "output_result" : [ {
      "key" : "new_issue_count",
      "value" : "0"
    }, {
      "key" : "codecheck.deadly",
      "value" : "0"
    }, {
      "key" : "codecheck.important",
      "value" : "0"
    }, {
      "key" : "codecheck.common",
      "value" : "0"
    }, {
      "key" : "codecheck.prompt",
      "value" : "0"
    } ]
  } ],
  "current_system_time" : 1710153194163
}

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
47
48
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 ShowStepOutputsSolution {

    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("<YOUR REGION>"))
                .build();
        ShowStepOutputsRequest request = new ShowStepOutputsRequest();
        request.withProjectId("{project_id}");
        request.withPipelineId("{pipeline_id}");
        request.withPipelineRunId("{pipeline_run_id}");
        try {
            ShowStepOutputsResponse response = client.showStepOutputs(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
32
33
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = ShowStepOutputsRequest()
        request.project_id = "{project_id}"
        request.pipeline_id = "{pipeline_id}"
        request.pipeline_run_id = "{pipeline_run_id}"
        response = client.show_step_outputs(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
37
38
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartspipeline.NewCodeArtsPipelineClient(
        codeartspipeline.CodeArtsPipelineClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowStepOutputsRequest{}
	request.ProjectId = "{project_id}"
	request.PipelineId = "{pipeline_id}"
	request.PipelineRunId = "{pipeline_run_id}"
	response, err := client.ShowStepOutputs(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

错误码

请参见错误码

相关文档