Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Obtaining the Pipeline Step Execution Output
Updated on 2025-03-25 GMT+08:00

Obtaining the Pipeline Step Execution Output

Function

Obtaining the Pipeline Step Execution Output

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

CodeArts project ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

pipeline_id

Yes

String

Parameter description:

Pipeline ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

pipeline_run_id

Yes

String

Parameter description:

Pipeline run ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

step_run_ids

Yes

String

Parameter description:

Pipeline step ID.

Constraints:

N/A

Value range:

Each ID is a string of 32 characters, consisting of only digits and letters.

Default value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Parameter description:

User token.

It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

None.

Value range:

None.

Default value:

None.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

step_outputs

Array of step_outputs objects

Parameter description:

Step output list, which records the output ID and result information of each step.

Constraints:

N/A

current_system_time

Long

Parameter description:

Current system time.

Value range:

N/A

Table 5 step_outputs

Parameter

Type

Description

step_run_id

String

Parameter description:

Step ID.

Value range:

32 characters.

output_result

Array of output_result objects

Parameter description:

Step output.

Value range:

None.

Table 6 output_result

Parameter

Type

Description

key

String

Parameter description:

Step output key value.

Value range:

None.

value

String

Parameter description:

Step output value.

Value range:

None.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

Example Requests

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

Example Responses

Status code: 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 Sample Code

The SDK sample code is as follows.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.