文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 查询参数组列表 - ListVariableGroups
更新时间:2026-09-24 GMT+08:00

查询参数组列表 - ListVariableGroups

功能介绍

查询参数组列表

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

offset

是

Long

偏移量

limit

是

Long

单页条数

name

否

String

名称模糊查询

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

pipeline_variable_groups

Array of pipeline_variable_groups objects

详情列表

offset

Integer

偏移量

limit

Integer

单页条数·

total

Integer

参数解释:

总条目数量。

取值范围:

大于等于0。

表4 pipeline_variable_groups

参数

参数类型

描述

id

String

参数组ID

project_id

String

项目ID

domain_id

String

租户ID

name

String

参数组名称

description

String

描述

variables

Array of strings

参数列表

related_pipelines

Array of related_pipelines objects

关联的流水线

creator_id

String

创建人ID

updater_id

String

更新人ID

creator_name

String

创建人名称

updater_name

String

更新人名称

create_time

Integer

创建时间

update_time

Integer

更新时间

请求示例

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

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

响应示例

状态码: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代码示例

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

更多

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

状态码

状态码

描述

200

响应体

错误码

请参见错误码。