更新时间:2024-11-29 GMT+08:00
分享

启动流水线

功能介绍

启动流水线

调用方法

请参见如何调用API

URI

POST /v3/pipelines/{pipeline_id}/start

表1 路径参数

参数

是否必选

参数类型

描述

pipeline_id

String

参数解释

流水线ID。

约束限制

不涉及。

取值范围

32位字符,仅由数字和字母组成。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

build_params

Array of StartPipelineBuildParams objects

启动流水线时的构建参数

表4 StartPipelineBuildParams

参数

是否必选

参数类型

描述

name

String

构建参数名

value

String

构建参数值,最大长度为8192

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

pipeline_id

String

流水线ID

build_id

String

流水线执行ID

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

请求示例

启动流水线。

指定启动时的运行参数为”ServiceName:pipeline-Test”和”version:1.0.0”。

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

响应示例

状态码: 200

OK

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

SDK代码示例

SDK代码示例如下。

启动流水线。

指定启动时的运行参数为”ServiceName:pipeline-Test”和”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
62
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();
        request.withPipelineId("{pipeline_id}");
        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());
        }
    }
}

启动流水线。

指定启动时的运行参数为”ServiceName:pipeline-Test”和”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
# 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()
        request.pipeline_id = "{pipeline_id}"
        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)

启动流水线。

指定启动时的运行参数为”ServiceName:pipeline-Test”和”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
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{}
	request.PipelineId = "{pipeline_id}"
	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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档