更新时间:2025-09-25 GMT+08:00
分享

运行gitcode流水线

功能介绍

运行gitcode流水线

调用方法

请参见如何调用API

URI

POST /v6/{domain_id}/api/pac/pipelines/actions/run

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

参数解释

租户ID。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

https_url

String

参数解释

触发URL。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

file_path

String

参数解释

文件存储路径。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

file_content

String

参数解释

文件详情。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

branch

String

参数解释

代码源分支名。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

encoding

String

参数解释

文件编码方式。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

tag

String

参数解释

代码源标签。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

commit_id

String

参数解释

代码源提交记录id。

约束限制

不涉及。

取值范围

40位字符。

默认取值

不涉及。

access_token

String

参数解释

代码源访问权限token。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

pipeline_id

String

参数解释

流水线ID,可以通过查询流水线列表接口,其中pipelines.pipelineId即为流水线ID。

取值范围

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

pipeline_run_id

String

参数解释

流水线运行实例ID,运行流水线接口的返回值即为流水线运行实例ID。

取值范围

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

请求示例

POST https://{endpoint}/v6/5c8305fa19154cabbb7f022a710f0ace/api/pac/pipelines/actions/run

{
  "https_url" : "https://example.com/api/pipeline",
  "file_path" : "/path/to/file",
  "file_content" : "Sample file content goes here.",
  "file_commit_id" : "abc123def456",
  "branch" : "main",
  "encoding" : "UTF-8",
  "tag" : "v1.0.0",
  "commit_id" : "xyz789uvw012",
  "access_token" : "your_access_token_here"
}

响应示例

状态码:200

OK

{
  "pipelineId" : "pipelineId",
  "pipelineRunId" : "pipelineRunId"
}

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
49
50
51
52
53
54
55
56
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 RunActionsPipelineSolution {

    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();
        RunActionsPipelineRequest request = new RunActionsPipelineRequest();
        request.withDomainId("{domain_id}");
        ActionsManualRunPipelineDTO body = new ActionsManualRunPipelineDTO();
        body.withAccessToken("your_access_token_here");
        body.withCommitId("xyz789uvw012");
        body.withTag("v1.0.0");
        body.withEncoding("UTF-8");
        body.withBranch("main");
        body.withFileContent("Sample file content goes here.");
        body.withFilePath("/path/to/file");
        body.withHttpsUrl("https://example.com/api/pipeline");
        request.withBody(body);
        try {
            RunActionsPipelineResponse response = client.runActionsPipeline(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
34
35
36
37
38
39
40
41
# 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 = RunActionsPipelineRequest()
        request.domain_id = "{domain_id}"
        request.body = ActionsManualRunPipelineDTO(
            access_token="your_access_token_here",
            commit_id="xyz789uvw012",
            tag="v1.0.0",
            encoding="UTF-8",
            branch="main",
            file_content="Sample file content goes here.",
            file_path="/path/to/file",
            https_url="https://example.com/api/pipeline"
        )
        response = client.run_actions_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)
 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
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.RunActionsPipelineRequest{}
	request.DomainId = "{domain_id}"
	accessTokenActionsManualRunPipelineDto:= "your_access_token_here"
	commitIdActionsManualRunPipelineDto:= "xyz789uvw012"
	tagActionsManualRunPipelineDto:= "v1.0.0"
	encodingActionsManualRunPipelineDto:= "UTF-8"
	branchActionsManualRunPipelineDto:= "main"
	fileContentActionsManualRunPipelineDto:= "Sample file content goes here."
	filePathActionsManualRunPipelineDto:= "/path/to/file"
	httpsUrlActionsManualRunPipelineDto:= "https://example.com/api/pipeline"
	request.Body = &model.ActionsManualRunPipelineDto{
		AccessToken: &accessTokenActionsManualRunPipelineDto,
		CommitId: &commitIdActionsManualRunPipelineDto,
		Tag: &tagActionsManualRunPipelineDto,
		Encoding: &encodingActionsManualRunPipelineDto,
		Branch: &branchActionsManualRunPipelineDto,
		FileContent: &fileContentActionsManualRunPipelineDto,
		FilePath: &filePathActionsManualRunPipelineDto,
		HttpsUrl: &httpsUrlActionsManualRunPipelineDto,
	}
	response, err := client.RunActionsPipeline(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档