Updated on 2024-06-14 GMT+08:00

Starting a Pipeline

Function

This API is used to start a pipeline.

Calling Method

For details, see Calling APIs.

URI

POST /v3/pipelines/{pipeline_id}/start

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

pipeline_id

Yes

String

Pipeline ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

build_params

No

Array of StartPipelineBuildParams objects

Build parameters for starting a pipeline.

Table 4 StartPipelineBuildParams

Parameter

Mandatory

Type

Description

name

Yes

String

Build parameter name.

value

Yes

String

Build parameter value, which contains a maximum of 8192 characters.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

pipeline_id

String

Pipeline ID.

build_id

String

Pipeline execution ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

Start a pipeline. Set the startup parameters to ServiceName:pipeline-Test and version:1.0.0.

{
  "build_params" : [ {
    "name" : "ServiceName",
    "value" : "pipeline-Test"
  }, {
    "name" : "version",
    "value" : "1.0.0"
  } ]
}

Example Responses

Status code: 200

OK

{
  "pipeline_id" : "8025ba36a87a4dd5af496708c2961817",
  "build_id" : "23"
}

SDK Sample Code

The SDK sample code is as follows.

Start a pipeline. Set the startup parameters to ServiceName:pipeline-Test and version:1.0.0.

 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
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 StartNewPipelineSolution {

    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();
        StartNewPipelineRequest request = new StartNewPipelineRequest();
        StartPipelineParameters body = new StartPipelineParameters();
        List<StartPipelineBuildParams> listbodyBuildParams = new ArrayList<>();
        listbodyBuildParams.add(
            new StartPipelineBuildParams()
                .withName("ServiceName")
                .withValue("pipeline-Test")
        );
        listbodyBuildParams.add(
            new StartPipelineBuildParams()
                .withName("version")
                .withValue("1.0.0")
        );
        body.withBuildParams(listbodyBuildParams);
        request.withBody(body);
        try {
            StartNewPipelineResponse response = client.startNewPipeline(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. Set the startup parameters to ServiceName:pipeline-Test and version:1.0.0.

 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
# 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 = StartNewPipelineRequest()
        listBuildParamsbody = [
            StartPipelineBuildParams(
                name="ServiceName",
                value="pipeline-Test"
            ),
            StartPipelineBuildParams(
                name="version",
                value="1.0.0"
            )
        ]
        request.body = StartPipelineParameters(
            build_params=listBuildParamsbody
        )
        response = client.start_new_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. Set the startup parameters to ServiceName:pipeline-Test and version:1.0.0.

 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 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.StartNewPipelineRequest{}
	var listBuildParamsbody = []model.StartPipelineBuildParams{
        {
            Name: "ServiceName",
            Value: "pipeline-Test",
        },
        {
            Name: "version",
            Value: "1.0.0",
        },
    }
	request.Body = &model.StartPipelineParameters{
		BuildParams: &listBuildParamsbody,
	}
	response, err := client.StartNewPipeline(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.