Updated on 2025-03-25 GMT+08:00

Starting a Pipeline

Function

This API is used to start a pipeline.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipelines/{pipeline_id}/run

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.

Request Parameters

Table 2 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

sources

No

Array of sources objects

Parameter description:

Code source information list.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

description

No

String

Parameter description:

Running description.

Constraints:

None.

Value range:

Up to 1024 characters.

Default value:

None.

variables

No

Array of variables objects

Custom parameters used.

choose_jobs

No

Array of strings

Parameter description:

Selected pipeline jobs.

Constraints:

None.

Value range:

None.

Default value:

None.

choose_stages

No

Array of strings

Parameter description:

Selected pipeline stages. The priority is higher than that of choose_jobs. That is, if a stage is not selected, jobs (selected in choose_jobs) under this stage are ignored.

Constraints:

N/A.

Value Range:

N/A.

Default value:

N/A.

Table 4 sources

Parameter

Mandatory

Type

Description

type

Yes

String

Parameter description:

Pipeline source type.

Constraints:

None.

Value range:

Currently, the code source type is supported.

Default value:

None.

params

No

params object

Source parameters.

Table 5 params

Parameter

Mandatory

Type

Description

git_type

Yes

String

Parameter description:

Code repository type.

Constraints:

N/A

Value range:

CodeArts Repo, Gitee, GitHub, GitCode, and GitLab are supported.

Default value:

N/A

alias

No

String

Parameter description:

Code repository alias. The alias is user-defined and is used to distinguish system parameters when there are multiple repositories. For example, A_REPO_COMMIT_ID, B_REPO_COMMIT_ID.

Constraints:

N/A.

Value Range:

N/A.

Default value:

N/A.

codehub_id

No

String

Parameter description:

CodeArts Repo code repository ID.

Constraints:

None.

Value range:

None.

Default value:

None.

default_branch

No

String

Parameter description:

Default branch of the code repository for pipeline execution.

Constraints:

None.

Value range:

None.

Default value:

None.

git_url

Yes

String

Parameter description:

HTTPS address of the Git repository, for example, https://example.com/CloudPipelinezycs00001/2000.git.

Constraints:

None.

Value range:

None.

Default value:

None.

endpoint_id

No

String

Parameter description:

ID of the code source endpoint.

Constraints:

None.

Value range:

None.

Default value:

None.

build_params

No

build_params object

Parameter description:

Detailed build parameters.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

change_request_ids

No

Array of strings

Parameter description:

Change IDs of the change-triggered pipeline.

Constraints:

N/A

Options:

N/A

Default value:

N/A

Table 6 build_params

Parameter

Mandatory

Type

Description

build_type

Yes

String

Parameter description:

Code repository trigger type.

Constraints:

None.

Value range:

branch: triggered by a branch; tag: triggered by a tag.

Default value:

None.

target_branch

No

String

Parameter description:

Branch that triggers the pipeline execution.

Constraints:

None.

Value range:

None.

Default value:

None.

tag

No

String

Parameter description:

Tag that triggers the pipeline execution.

Constraints:

None.

Value range:

None.

Default value:

None.

Table 7 variables

Parameter

Mandatory

Type

Description

name

Yes

String

Parameter description:

Parameter name.

Constraints:

None.

Value range:

None.

Default value:

None.

value

Yes

String

Parameter description:

Parameter value.

Constraints:

None.

Value range:

Up to 8192 characters.

Default value:

None.

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

pipeline_run_id

String

Parameter description:

Pipeline run ID.

Value range:

32 characters, including only digits and letters.

Example Requests

Start a pipeline.

The specified branch is master, and the parameter is key:val.

POST https://{endpoint}/v5/54f90b75fc1447b1b65e8d3a9f77923d/api/pipelines/e5460d1d403146a1935c2d4b68ef506c/run

{
  "sources" : [ {
    "type" : "code",
    "params" : {
      "git_type" : "codehub",
      "codehub_id" : "2111699716",
      "default_branch" : "test-lbdsb11",
      "git_url" : "https://example.com/clsyz00001/111.git",
      "build_params" : {
        "build_type" : "branch",
        "event_type" : "Manual",
        "target_branch" : "test-lbdsb11"
      }
    }
  } ],
  "description" : "Running description",
  "variables" : [ {
    "name" : "key",
    "value" : "val"
  } ],
  "choose_jobs" : [ "16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4" ]
}

Example Responses

Status code: 200

OK

{
  "pipeline_run_id" : "ad6b7f66283a45be9c1f82b06c831e59"
}

SDK Sample Code

The SDK sample code is as follows.

Start a pipeline.

The specified branch is master, and the parameter is key:val.

 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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.*;

import java.util.List;
import java.util.ArrayList;

public class RunPipelineSolution {

    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();
        RunPipelineRequest request = new RunPipelineRequest();
        request.withProjectId("{project_id}");
        request.withPipelineId("{pipeline_id}");
        RunPipelineDTO body = new RunPipelineDTO();
        []string listbodyChooseJobs = new ArrayList<>();
        listbodyChooseJobs.add("16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4");
        [](model.RunPipelineDtoVariables) listbodyVariables = new ArrayList<>();
        listbodyVariables.add(
            new RunPipelineDTOVariables()
                .withName("key")
                .withValue("val")
        );
        RunPipelineDTOParamsBuildParams buildParamsParams = new RunPipelineDTOParamsBuildParams();
        buildParamsParams.withBuildType("branch")
            .withTargetBranch("test-lbdsb11")
            .withEventType("Manual");
        RunPipelineDTOParams paramsSources = new RunPipelineDTOParams();
        paramsSources.withGitType("codehub")
            .withCodehubId("2111699716")
            .withDefaultBranch("test-lbdsb11")
            .withGitUrl("https://example.com/clsyz00001/111.git")
            .withBuildParams(buildParamsParams);
        [](model.RunPipelineDtoSources) listbodySources = new ArrayList<>();
        listbodySources.add(
            new RunPipelineDTOSources()
                .withType("code")
                .withParams(paramsSources)
        );
        body.withChooseJobs(listbodyChooseJobs);
        body.withVariables(listbodyVariables);
        body.withDescription("Running description");
        body.withSources(listbodySources);
        request.withBody(body);
        try {
            RunPipelineResponse response = client.runPipeline(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());
        }
    }
}

Start a pipeline.

The specified branch is master, and the parameter is key:val.

 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# 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 = RunPipelineRequest()
        request.project_id = "{project_id}"
        request.pipeline_id = "{pipeline_id}"
        listChooseJobsbody = [
            "16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4"
        ]
        listVariablesbody = [
            RunPipelineDTOVariables(
                name="key",
                value="val"
            )
        ]
        buildParamsParams = RunPipelineDTOParamsBuildParams(
            build_type="branch",
            target_branch="test-lbdsb11",
            event_type="Manual"
        )
        paramsSources = RunPipelineDTOParams(
            git_type="codehub",
            codehub_id="2111699716",
            default_branch="test-lbdsb11",
            git_url="https://example.com/clsyz00001/111.git",
            build_params=buildParamsParams
        )
        listSourcesbody = [
            RunPipelineDTOSources(
                type="code",
                params=paramsSources
            )
        ]
        request.body = RunPipelineDTO(
            choose_jobs=listChooseJobsbody,
            variables=listVariablesbody,
            description="Running description",
            sources=listSourcesbody
        )
        response = client.run_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)

Start a pipeline.

The specified branch is master, and the parameter is key:val.

 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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.RunPipelineRequest{}
	request.ProjectId = "{project_id}"
	request.PipelineId = "{pipeline_id}"
	var listChooseJobsbody = []string{
        "16772939480734f4abbc4-b3b9-4235-82c2-46559434cbd4",
    }
	var listVariablesbody = []model.RunPipelineDtoVariables{
        {
            Name: "key",
            Value: "val",
        },
    }
	targetBranchBuildParams:= "test-lbdsb11"
	eventTypeBuildParams:= "Manual"
	buildParamsParams := &model.RunPipelineDtoParamsBuildParams{
		BuildType: "branch",
		TargetBranch: &targetBranchBuildParams,
		EventType: &eventTypeBuildParams,
	}
	codehubIdParams:= "2111699716"
	defaultBranchParams:= "test-lbdsb11"
	paramsSources := &model.RunPipelineDtoParams{
		GitType: "codehub",
		CodehubId: &codehubIdParams,
		DefaultBranch: &defaultBranchParams,
		GitUrl: "https://example.com/clsyz00001/111.git",
		BuildParams: buildParamsParams,
	}
	var listSourcesbody = []model.RunPipelineDtoSources{
        {
            Type: "code",
            Params: paramsSources,
        },
    }
	descriptionRunPipelineDto:= "Running description"
	request.Body = &model.RunPipelineDto{
		ChooseJobs: &listChooseJobsbody,
		Variables: &listVariablesbody,
		Description: &descriptionRunPipelineDto,
		Sources: &listSourcesbody,
	}
	response, err := client.RunPipeline(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

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.