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

Querying Details About a Parameter Group

Function

This API is used to query details about a parameter group.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipeline/variable/group/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition:

Parameter group ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

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

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

id

String

Definition:

Parameter group name.

Value range:

N/A

project_id

String

Definition:

Project name.

Value range:

N/A

domain_id

String

Definition:

Tenant ID, that is, domain ID of a user.

Range:

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

name

String

Definition:

Parameter group name.

Value range:

N/A

description

String

Definition:

Parameter group description.

Value range:

N/A

variables

Array of variables objects

Definition:

Parameter list.

Value range:

N/A

related_pipelines

Array of related_pipelines objects

Definition:

Associated pipeline.

Value range:

N/A

creator_id

String

Definition:

Creator ID.

Value range:

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

updater_id

String

Definition:

Editor ID

Value range:

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

creator_name

String

Definition:

Creator name.

Value range:

N/A

updater_name

String

Definition:

Editor name.

Value range:

N/A

create_time

Integer

Definition:

Creation time.

Value range:

N/A

update_time

Integer

Definition:

Update time.

Value range:

N/A

Table 3 variables

Parameter

Type

Description

name

String

Definition:

Parameter name.

Value range:

N/A

sequence

Integer

Definition:

Sequence number of a parameter.

Value range:

N/A

type

String

Definition:

Parameter type.

Value range:

N/A

value

String

Definition:

Default parameter value.

Value range:

N/A

is_secret

Boolean

Definition:

Whether the parameter is private.

Value range:

  • true: The parameter is private.

  • false: The parameter is not private.

description

String

Definition:

Description.

Value range:

N/A

Example Requests

GET https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline/variable/group/e9b95653dd854146b9ff48d33c2d9d66

Example Responses

Status code: 200

{
  "id" : "e9b95653dd854146b9ff48d33c2d9d66",
  "project_id" : "e2e18230a85d4d6ab0b56cb6d2246c18",
  "domain_id" : "4b267c81b33648d982e5c2067e4c77b9",
  "name" : "121212",
  "description" : "",
  "variables" : [ {
    "name" : "12",
    "sequence" : 1,
    "type" : "string",
    "value" : "12",
    "is_secret" : false,
    "description" : ""
  } ],
  "related_pipelines" : [ {
    "id" : "0747d5a7099e45f69dc1d099945909a9",
    "name" : "cloudtest"
  } ],
  "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
  "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
  "creator_name" : "12-5",
  "updater_name" : "12-5",
  "create_time" : 1718957748000,
  "update_time" : 1718958969000
}

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

    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();
        ShowVariableGroupDetailRequest request = new ShowVariableGroupDetailRequest();
        request.withId("{id}");
        request.withProjectId("{project_id}");
        try {
            ShowVariableGroupDetailResponse response = client.showVariableGroupDetail(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
# 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 = ShowVariableGroupDetailRequest()
        request.id = "{id}"
        request.project_id = "{project_id}"
        response = client.show_variable_group_detail(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
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.ShowVariableGroupDetailRequest{}
	request.Id = "{id}"
	request.ProjectId = "{project_id}"
	response, err := client.ShowVariableGroupDetail(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.