Updated on 2025-11-12 GMT+08:00

Running a GitCode Pipeline

Function

This API is used to run a GitCode pipeline.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Definition:

Tenant ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

https_url

No

String

Definition:

Trigger URL.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

file_path

No

String

Definition:

File storage path.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

file_content

No

String

Definition:

File details.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

branch

No

String

Definition:

Name of the code source branch.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

encoding

No

String

Definition:

File encoding mode.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

tag

No

String

Definition:

Code source tag.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

commit_id

No

String

Definition:

Commit ID in code source.

Constraints:

N/A

Value range:

The value contains 40 characters.

Default value:

N/A

access_token

No

String

Definition:

Token for accessing the code source.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

pipeline_id

String

Definition:

Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID.

Value range:

The value consists of 32 characters, including only digits and letters.

pipeline_run_id

String

Definition:

Pipeline run ID. The return value of the API for running a pipeline is the pipeline run ID.

Value range:

The value consists of 32 characters, including only digits and letters.

Example Requests

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.",
  "branch" : "main",
  "encoding" : "UTF-8",
  "tag" : "v1.0.0",
  "commit_id" : "xyz789uvw012",
  "access_token" : "your_access_token_here"
}

Example Responses

Status code: 200

OK

{
  "pipeline_id" : "pipelineId",
  "pipeline_run_id" : "pipelineRunId"
}

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

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

Error Codes

See Error Codes.