文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 创建参数组 - CreateVariableGroup
更新时间:2026-09-18 GMT+08:00

创建参数组 - CreateVariableGroup

功能介绍

根据参数组详情创建参数组

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

projectId

是

String

参数解释:

项目ID,获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

name

是

String

参数解释:

参数组名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

description

否

String

参数解释:

描述详情。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

variables

否

Array of variables objects

参数解释:

参数列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 variables

参数

是否必选

参数类型

描述

sequence

否

Integer

参数解释:

参数序号。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

name

否

String

参数解释:

参数名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

type

否

String

参数解释:

参数类型。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

value

否

String

参数解释:

参数默认值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

description

否

String

参数解释:

参数描述。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

is_secret

否

Boolean

参数解释:

是否私密参数。

约束限制:

不涉及。

取值范围:

  • true:是私密参数。

  • false:不是私密参数。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

pipeline_variable_group_id

String

参数解释:

参数组ID。

取值范围:

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

请求示例

POST https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline/variable/group/create

{
  "projectId" : "e2e18230a85d4d6ab0b56cb6d2246c18",
  "name" : "213",
  "description" : "",
  "variables" : [ {
    "sequence" : 1,
    "name" : "123",
    "type" : "string",
    "value" : "123",
    "description" : "123",
    "is_secret" : false
  } ]
}

响应示例

状态码:200

{
  "pipeline_variable_group_id" : "66d40ba4e3da4505aaaf7e9de9860b6e"
}

SDK代码示例

SDK代码示例如下。

Java

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

    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();
        CreateVariableGroupRequest request = new CreateVariableGroupRequest();
        request.withProjectId("{project_id}");
        CreateVariableGroupReq body = new CreateVariableGroupReq();
        List<CreateVariableGroupReqVariables> listbodyVariables = new ArrayList<>();
        listbodyVariables.add(
            new CreateVariableGroupReqVariables()
                .withSequence(1)
                .withName("123")
                .withType("string")
                .withValue("123")
                .withDescription("123")
                .withIsSecret(false)
        );
        body.withVariables(listbodyVariables);
        body.withDescription("");
        body.withName("213");
        request.withBody(body);
        try {
            CreateVariableGroupResponse response = client.createVariableGroup(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());
        }
    }
}

Python

 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
# 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 = CreateVariableGroupRequest()
        request.project_id = "{project_id}"
        listVariablesbody = [
            CreateVariableGroupReqVariables(
                sequence=1,
                name="123",
                type="string",
                value="123",
                description="123",
                is_secret=False
            )
        ]
        request.body = CreateVariableGroupReq(
            variables=listVariablesbody,
            description="",
            name="213"
        )
        response = client.create_variable_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)

Go

 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
64
65
66
67
68
69
70
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := codeartspipeline.CodeArtsPipelineClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := codeartspipeline.NewCodeArtsPipelineClient(hcClient)

    request := &model.CreateVariableGroupRequest{}
	request.ProjectId = "{project_id}"
	sequenceVariables:= int32(1)
	nameVariables:= "123"
	typeVariables:= "string"
	valueVariables:= "123"
	descriptionVariables:= "123"
	isSecretVariables:= false
	var listVariablesbody = []model.CreateVariableGroupReqVariables{
        {
            Sequence: &sequenceVariables,
            Name: &nameVariables,
            Type: &typeVariables,
            Value: &valueVariables,
            Description: &descriptionVariables,
            IsSecret: &isSecretVariables,
        },
    }
	descriptionCreateVariableGroupReq:= ""
	request.Body = &model.CreateVariableGroupReq{
		Variables: &listVariablesbody,
		Description: &descriptionCreateVariableGroupReq,
		Name: "213",
	}
	response, err := client.CreateVariableGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

响应体

错误码

请参见错误码。