Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying the Parameter Group List
Updated on 2026-09-24 GMT+08:00

Querying the Parameter Group List

Function

This API is used to query the parameter group list.

Calling Method

For details, see Calling APIs.

URI

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

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

offset

Yes

Long

Offset.

limit

Yes

Long

Number of records on each page.

name

No

String

Fuzzy search by name.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

pipeline_variable_groups

Array of pipeline_variable_groups objects

Details list.

offset

Integer

Offset.

limit

Integer

Number of records on each page.

total

Integer

Definition:

Total number of items.

Value range:

The value is no less than 0.

Table 4 pipeline_variable_groups

Parameter

Type

Description

id

String

Parameter group ID.

project_id

String

Project ID.

domain_id

String

Tenant ID.

name

String

Parameter group name.

description

String

Description.

variables

Array of strings

Parameter list.

related_pipelines

Array of related_pipelines objects

Associated pipeline.

creator_id

String

Creator ID.

updater_id

String

Updated by ID.

creator_name

String

Creator name.

updater_name

String

Updater name.

create_time

Integer

Creation time.

update_time

Integer

Update time.

Example Requests

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

{
  "offset" : 0,
  "limit" : 10,
  "name" : ""
}

Example Responses

Status code: 200

{
  "pipeline_variable_groups" : [ {
    "id" : "e9b95653dd854146b9ff48d33c2d9d66",
    "project_id" : "e2e18230a85d4d6ab0b56cb6d2246c18",
    "domain_id" : "4b267c81b33648d982e5c2067e4c77b9",
    "name" : "121212",
    "description" : "",
    "variables" : [ ],
    "related_pipelines" : [ {
      "id" : "0747d5a7099e45f69dc1d099945909a9",
      "name" : "cloudtest"
    }, {
      "id" : "dc73b5ed58a64ab7a469b9480e5f6632",
      "name" : "PY3-0401-pipeline"
    } ],
    "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
    "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
    "creator_name" : "north-5",
    "updater_name" : "north-5",
    "create_time" : 1718957748000,
    "update_time" : 1718958969000
  } ],
  "offset" : 0,
  "limit" : 10,
  "total" : 1
}

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

    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();
        ListVariableGroupsRequest request = new ListVariableGroupsRequest();
        request.withProjectId("{project_id}");
        ListVariableGroupsReq body = new ListVariableGroupsReq();
        body.withName("");
        body.withLimit(10);
        body.withOffset(0);
        request.withBody(body);
        try {
            ListVariableGroupsResponse response = client.listVariableGroups(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
# 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 = ListVariableGroupsRequest()
        request.project_id = "{project_id}"
        request.body = ListVariableGroupsReq(
            name="",
            limit=10,
            offset=0
        )
        response = client.list_variable_groups(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
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.ListVariableGroupsRequest{}
	request.ProjectId = "{project_id}"
	nameListVariableGroupsReq:= ""
	limitListVariableGroupsReq:= int32(10)
	offsetListVariableGroupsReq:= int32(0)
	request.Body = &model.ListVariableGroupsReq{
		Name: &nameListVariableGroupsReq,
		Limit: &limitListVariableGroupsReq,
		Offset: &offsetListVariableGroupsReq,
	}
	response, err := client.ListVariableGroups(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.