Updated on 2026-09-18 GMT+08:00

Creating a Parameter Group

Function

This API is used to create a parameter group based on its details.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project 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

projectId

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

name

Yes

String

Definition:

Parameter group name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

description

No

String

Definition:

Description details.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

variables

No

Array of variables objects

Definition:

Parameter list.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 3 variables

Parameter

Mandatory

Type

Description

sequence

No

Integer

Definition:

Sequence number of a parameter.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

name

No

String

Definition:

Parameter name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

type

No

String

Definition:

Parameter type.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

value

No

String

Definition:

Default parameter value.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

description

No

String

Definition:

Parameter description.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

is_secret

No

Boolean

Definition:

Private parameter or not.

Constraints:

N/A

Value range:

  • true: The parameter is private.

  • false: The parameter is not private.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

pipeline_variable_group_id

String

Definition:

Parameter group ID.

Value range:

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

Example Requests

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

Example Responses

Status code: 200

{
  "pipeline_variable_group_id" : "66d40ba4e3da4505aaaf7e9de9860b6e"
}

SDK Sample Code

The SDK sample code is as follows.

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

More

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

Response body.

Error Codes

See Error Codes.