文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 分组管理/ 批量把流水线移动到分组下
更新时间:2024-11-29 GMT+08:00
分享

批量把流水线移动到分组下

功能介绍

批量把流水线移动到分组下

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

CodeArts项目ID。

约束限制

不涉及

取值范围

32位字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

group_id

String

分组ID

pipelines

Array of pipelines objects

流水线集合

表4 pipelines

参数

是否必选

参数类型

描述

pipeline_id

String

流水线ID

pipeline_name

String

流水线名

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array<Array<PipelineMoveToGroupResponseVo>>

参数解释

PipelineMoveToGroupResponseVo列表,包含各个操作的响应码 ["failed", "success"]。

约束限制

不涉及。

表6 PipelineMoveToGroupResponseVo

参数

参数类型

描述

code

String

响应码 ["failed", "success"]

pipeline_id

String

流水线ID

pipeline_name

String

流水线名

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

请求示例

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"
  } ]
}

响应示例

状态码: 200

参数解释

PipelineMoveToGroupResponseVo列表,包含各个操作的响应码 ["failed", "success"]。

约束限制

不涉及。

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

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
57
58
59
60
61
62
63
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();
        request.withProjectId("{project_id}");
        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
45
# 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()
        request.project_id = "{project_id}"
        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
50
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{}
	request.ProjectId = "{project_id}"
	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)
    }
}

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

状态码

状态码

描述

200

参数解释

PipelineMoveToGroupResponseVo列表,包含各个操作的响应码 ["failed", "success"]。

约束限制

不涉及。

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档