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

新建流水线分组

功能介绍

新建流水线分组

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释: CodeArts项目ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释: 流水线分组名。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。

project_id

String

参数解释: CodeArts项目ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。

parent_id

String

参数解释: 父分组ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释: 分组ID。 取值范围: 32位字符。

domain_id

String

参数解释: 租户ID。 取值范围: 32位字符。

project_id

String

参数解释: 项目ID。 取值范围: 32位字符。

name

String

参数解释: 分组名。 取值范围: 32位字符。

parent_id

String

参数解释: 父分组ID。 取值范围: 32位字符。

path_id

String

参数解释: 分组路径ID。例如id1.id2.id3 代表分组id3的父分组为id2,分组id2的父分组为id1。 取值范围: 不涉及。

ordinal

Integer

参数解释: 序号。 取值范围: 大于等于1。

creator

String

参数解释: 创建用户ID。 取值范围: 32位字符。

updater

String

参数解释: 更新用户ID。 取值范围: 32位字符。

create_time

Long

参数解释: 创建时间。 取值范围: 不涉及。

update_time

Long

参数解释: 更新时间。 取值范围: 不涉及。

children

Array of PipelineGroupVo objects

参数解释: 子分组列表。 取值范围: 不涉及。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释: 错误信息。 取值范围: 不涉及。

error_code

String

参数解释: 错误码。 取值范围: 不涉及。

请求示例

创建G1分组

POST https://{endpoint}/v5/{project_id}/api/pipeline-group/create

{
  "name" : "G1",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "parent_id" : ""
}

响应示例

状态码: 200

OK

{
  "id" : "58d55f8a646443a984e7399632b3963e",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "name" : "G1",
  "parent_id" : "",
  "path_id" : "58d55f8a646443a984e7399632b3963e",
  "ordinal" : 0,
  "creator" : "847a5317086c41798469d0868535943a",
  "updater" : null,
  "create_time" : null,
  "update_time" : null,
  "children" : null
}

SDK代码示例

SDK代码示例如下。

创建G1分组

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

    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();
        CreatePipelineGroupRequest request = new CreatePipelineGroupRequest();
        PipelineGroupCreateDTO body = new PipelineGroupCreateDTO();
        body.withParentId("");
        body.withProjectId("d80a8a6530324b7bac972cbb8a9f28ec");
        body.withName("G1");
        request.withBody(body);
        try {
            CreatePipelineGroupResponse response = client.createPipelineGroup(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());
        }
    }
}

创建G1分组

 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
# 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 = CreatePipelineGroupRequest()
        request.body = PipelineGroupCreateDTO(
            parent_id="",
            project_id="d80a8a6530324b7bac972cbb8a9f28ec",
            name="G1"
        )
        response = client.create_pipeline_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)

创建G1分组

 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
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.CreatePipelineGroupRequest{}
	parentIdPipelineGroupCreateDto:= ""
	request.Body = &model.PipelineGroupCreateDto{
		ParentId: &parentIdPipelineGroupCreateDto,
		ProjectId: "d80a8a6530324b7bac972cbb8a9f28ec",
		Name: "G1",
	}
	response, err := client.CreatePipelineGroup(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

错误码

请参见错误码

相关文档