Help Center/ CodeArts Pipeline/ API Reference/ API/ Group Management/ Querying the Pipeline Group Tree
Updated on 2025-03-25 GMT+08:00

Querying the Pipeline Group Tree

Function

This API is used to query the pipeline group tree.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipeline-group/tree

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

CodeArts project ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Parameter description:

User token.

It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

None.

Value range:

None.

Default value:

None.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of PipelineGroupVo objects

Parameter description: Pipeline group parameter list. PipelineGroupVo stores pipeline group parameters, including the IDs of parent and child groups. Constraints: None.

Table 4 PipelineGroupVo

Parameter

Type

Description

id

String

Parameter description:

Group ID.

Value range:

32 characters.

domain_id

String

Parameter description:

Tenant ID.

Value range:

32 characters.

project_id

String

Parameter description:

Project ID.

Value range:

32 characters.

name

String

Parameter description:

Group name.

Value range:

32 characters.

parent_id

String

Parameter description:

Parent group ID.

Value range:

32 characters.

path_id

String

Parameter description:

Group path ID. For example, id1.id2.id3 indicates that the parent group of group id3 is id2, and the parent group of group** id2** is id1.

Value range:

None.

ordinal

Integer

Parameter description:

No.

Value range:

No less than 1.

creator

String

Parameter description:

Creator ID.

Value range:

32 characters.

updater

String

Parameter description:

Updater ID.

Value range:

32 characters.

create_time

Long

Parameter description:

Creation time.

Value range:

None.

update_time

Long

Parameter description:

Update time.

Value range:

None.

children

Array of PipelineGroupVo objects

PipelineGroupVo

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

Example Requests

GET https://{endpoint}/v5/d80a8a6530324b7bac972cbb8a9f28ec/api/pipeline-group/tree

Example Responses

Status code: 200

OK

[ {
  "id" : "894daf0db79c4ccb839490770fa06596",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "name" : "Creating a Group 22",
  "parent_id" : "",
  "path_id" : "894daf0db79c4ccb839490770fa06596",
  "ordinal" : 2,
  "creator" : "847a5317086c41798469d0868535943a",
  "updater" : null,
  "create_time" : 1698487536000,
  "update_time" : null,
  "children" : null
}, {
  "id" : "2ca78947b25847a9ab68a07d8ef1347b",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "name" : "Creating group 11",
  "parent_id" : "",
  "path_id" : "2ca78947b25847a9ab68a07d8ef1347b",
  "ordinal" : 1,
  "creator" : "847a5317086c41798469d0868535943a",
  "updater" : null,
  "create_time" : 1698487008000,
  "update_time" : null,
  "children" : null
}, {
  "id" : "58d55f8a646443a984e7399632b3963e",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "name" : "G2",
  "parent_id" : "",
  "path_id" : "58d55f8a646443a984e7399632b3963e",
  "ordinal" : 0,
  "creator" : "847a5317086c41798469d0868535943a",
  "updater" : "847a5317086c41798469d0868535943a",
  "create_time" : 1698484566000,
  "update_time" : 1698485674000,
  "children" : [ {
    "id" : "d805c90bf99049d3a49e83d2024df6b8",
    "domain_id" : "ce8df55870164338a72d7e828a966a2a",
    "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
    "name" : "Creating group 3",
    "parent_id" : "58d55f8a646443a984e7399632b3963e",
    "path_id" : "58d55f8a646443a984e7399632b3963e.d805c90bf99049d3a49e83d2024df6b8",
    "ordinal" : 1,
    "creator" : "847a5317086c41798469d0868535943a",
    "updater" : "847a5317086c41798469d0868535943a",
    "create_time" : 1698487527000,
    "update_time" : 1698487868000,
    "children" : null
  }, {
    "id" : "ebb779b3b9f742e181b1f6829fa1aca0",
    "domain_id" : "ce8df55870164338a72d7e828a966a2a",
    "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
    "name" : "Creating a Group",
    "parent_id" : "58d55f8a646443a984e7399632b3963e",
    "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0",
    "ordinal" : 0,
    "creator" : "847a5317086c41798469d0868535943a",
    "updater" : null,
    "create_time" : 1698485344000,
    "update_time" : null,
    "children" : [ {
      "id" : "1b80aa3df0984e9caffefdc4e557524e",
      "domain_id" : "ce8df55870164338a72d7e828a966a2a",
      "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
      "name" : "Creating group 4",
      "parent_id" : "ebb779b3b9f742e181b1f6829fa1aca0",
      "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0.1b80aa3df0984e9caffefdc4e557524e",
      "ordinal" : 2,
      "creator" : "847a5317086c41798469d0868535943a",
      "updater" : null,
      "create_time" : 1698487502000,
      "update_time" : null,
      "children" : null
    }, {
      "id" : "6bc8a3cda52c41fe84d71c9ff86161ea",
      "domain_id" : "ce8df55870164338a72d7e828a966a2a",
      "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
      "name" : "Creating group 3",
      "parent_id" : "ebb779b3b9f742e181b1f6829fa1aca0",
      "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0.6bc8a3cda52c41fe84d71c9ff86161ea",
      "ordinal" : 1,
      "creator" : "847a5317086c41798469d0868535943a",
      "updater" : null,
      "create_time" : 1698486710000,
      "update_time" : null,
      "children" : null
    } ]
  } ]
} ]

SDK Sample Code

The SDK sample code is as follows.

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

    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();
        ShowPipelineGroupTreeRequest request = new ShowPipelineGroupTreeRequest();
        request.withProjectId("{project_id}");
        try {
            ShowPipelineGroupTreeResponse response = client.showPipelineGroupTree(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());
        }
    }
}
 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
# 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 = ShowPipelineGroupTreeRequest()
        request.project_id = "{project_id}"
        response = client.show_pipeline_group_tree(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartspipeline.NewCodeArtsPipelineClient(
        codeartspipeline.CodeArtsPipelineClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowPipelineGroupTreeRequest{}
	request.ProjectId = "{project_id}"
	response, err := client.ShowPipelineGroupTree(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.