Help Center/ CodeArts Pipeline/ API Reference/ API/ Group Management/ Moving Multiple Pipelines To a Group
Updated on 2024-06-14 GMT+08:00

Moving Multiple Pipelines To a Group

Function

This API is used to move multiple pipelines to a group.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipeline-group/pipeline/move

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project 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

group_id

Yes

String

Group ID.

pipelines

Yes

Array of pipelines objects

Pipeline set.

Table 4 pipelines

Parameter

Mandatory

Type

Description

pipeline_id

Yes

String

Pipeline ID.

pipeline_name

Yes

String

Pipeline name.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of PipelineMoveToGroupResponseVo objects

OK

Table 6 PipelineMoveToGroupResponseVo

Parameter

Type

Description

code

String

Response code ["failed", "success"]

pipeline_id

String

Pipeline ID.

pipeline_name

String

Pipeline name.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

POST https://{endpoint}/v5/d80a8a6530324b7bac972cbb8a9f28ec/api/pipeline-group/pipeline/move

{
  "group_id" : "2ca78947b25847a9ab68a07d8ef1347b",
  "pipelines" : [ {
    "pipeline_id" : "1ae88404911a4513bcdf8158ab6a0416",
    "pipeline_name" : "sdfgsdfgdfsg345345"
  }, {
    "pipeline_id" : "b99de7c698264251ac1fc3c053dc2b34",
    "pipeline_name" : "32131233131025122241"
  } ]
}

Example Responses

Status code: 200

OK

[ {
  "code" : "success",
  "pipeline_id" : "1ae88404911a4513bcdf8158ab6a0416",
  "pipeline_name" : "sdfgsdfgdfsg345345"
}, {
  "code" : "success",
  "pipeline_id" : "b99de7c698264251ac1fc3c053dc2b34",
  "pipeline_name" : "32131233131025122241"
} ]

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

    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();
        BatchMovePipelineToGroupRequest request = new BatchMovePipelineToGroupRequest();
        PipelineGroupBindDTO body = new PipelineGroupBindDTO();
        List<PipelineGroupBindDTOPipelines> listbodyPipelines = new ArrayList<>();
        listbodyPipelines.add(
            new PipelineGroupBindDTOPipelines()
                .withPipelineId("1ae88404911a4513bcdf8158ab6a0416")
                .withPipelineName("sdfgsdfgdfsg345345")
        );
        listbodyPipelines.add(
            new PipelineGroupBindDTOPipelines()
                .withPipelineId("b99de7c698264251ac1fc3c053dc2b34")
                .withPipelineName("32131233131025122241")
        );
        body.withPipelines(listbodyPipelines);
        body.withGroupId("2ca78947b25847a9ab68a07d8ef1347b");
        request.withBody(body);
        try {
            BatchMovePipelineToGroupResponse response = client.batchMovePipelineToGroup(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
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 = BatchMovePipelineToGroupRequest()
        listPipelinesbody = [
            PipelineGroupBindDTOPipelines(
                pipeline_id="1ae88404911a4513bcdf8158ab6a0416",
                pipeline_name="sdfgsdfgdfsg345345"
            ),
            PipelineGroupBindDTOPipelines(
                pipeline_id="b99de7c698264251ac1fc3c053dc2b34",
                pipeline_name="32131233131025122241"
            )
        ]
        request.body = PipelineGroupBindDTO(
            pipelines=listPipelinesbody,
            group_id="2ca78947b25847a9ab68a07d8ef1347b"
        )
        response = client.batch_move_pipeline_to_group(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
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.BatchMovePipelineToGroupRequest{}
	var listPipelinesbody = []model.PipelineGroupBindDtoPipelines{
        {
            PipelineId: "1ae88404911a4513bcdf8158ab6a0416",
            PipelineName: "sdfgsdfgdfsg345345",
        },
        {
            PipelineId: "b99de7c698264251ac1fc3c053dc2b34",
            PipelineName: "32131233131025122241",
        },
    }
	request.Body = &model.PipelineGroupBindDto{
		Pipelines: listPipelinesbody,
		GroupId: "2ca78947b25847a9ab68a07d8ef1347b",
	}
	response, err := client.BatchMovePipelineToGroup(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.