Querying a Group Tree
Function
This API is used to query a group tree.
Calling Method
For details, see Calling APIs.
URI
GET /v1/job/{project_id}/group/tree
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition CodeArts project ID. For details, seeObtaining a CodeArts Project ID. Constraints N/A. Range Use a 32-character string containing a mix of digits and letters. Default Value N/A. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
result |
Array of JobGroupTreeResponseBody objects |
Returned result. |
|
error |
String |
Returned error message. |
|
status |
String |
Returned status information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Group ID. |
|
domain_id |
String |
Tenant ID. |
|
project_id |
String |
CodeArts project ID. ID of the project to which the build task belongs. |
|
name |
String |
Group name. |
|
parent_id |
String |
Parent group ID. |
|
path_id |
String |
Group path. |
|
ordinal |
Integer |
Ordinal. |
|
create_user |
String |
User who creates the group. |
|
update_user |
String |
User who updates the group. |
|
create_time |
String |
Creation time. |
|
update_time |
String |
Update time. |
|
children |
Array of JobGroupTreeResponseBody objects |
Child group. |
Example Requests
GET https://{endpoint}/v1/job/{project_id}/group/tree
Example Responses
Status code: 200
OK
{
"result" : [ {
"id" : "b13c933bbc6f4d09a98ef09e4cc07e17",
"domain_id" : "60021bab32fd450aa2cb89226f425e06",
"project_id" : "923785f9674548259144259077bc6a98",
"name" : "New group-2160794",
"parent_id" : null,
"path_id" : "b13c933bbc6f4d09a98ef09e4cc07e17",
"ordinal" : 0,
"create_user" : "devcloud_codeci_z00485259_02",
"update_user" : null,
"create_time" : "2025-06-05T07:06:50+0800",
"update_time" : null,
"children" : [ {
"id" : "e2c52ec7654948c09e635697a4ffcb59",
"domain_id" : "60021bab32fd450aa2cb89226f425e06",
"project_id" : "923785f9674548259144259077bc6a98",
"name" : "2225 (Group testing)",
"parent_id" : "b13c933bbc6f4d09a98ef09e4cc07e17",
"path_id" : "b13c933bbc6f4d09a98ef09e4cc07e17.e2c52ec7654948c09e635697a4ffcb59",
"ordinal" : 7,
"create_user" : "devcloud_codeci_z00485259_02",
"update_user" : null,
"create_time" : "2025-06-10T09:50:28+0800",
"update_time" : null,
"children" : null
}, {
"id" : "70e158b6054e442893d7f5a79d34ce61",
"domain_id" : "60021bab32fd450aa2cb89226f425e06",
"project_id" : "923785f9674548259144259077bc6a98",
"name" : "New group (237)",
"parent_id" : "b13c933bbc6f4d09a98ef09e4cc07e17",
"path_id" : "b13c933bbc6f4d09a98ef09e4cc07e17.70e158b6054e442893d7f5a79d34ce61",
"ordinal" : 6,
"create_user" : "devcloud_codeci_z00485259_02",
"update_user" : "devcloud_codeci_z00485259_02",
"create_time" : "2025-06-09T02:55:39+0800",
"update_time" : "2025-06-09T02:58:36+0800",
"children" : null
} ]
} ],
"error" : null,
"status" : "success"
}
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.codeartsbuild.v3.region.CodeArtsBuildRegion; import com.huaweicloud.sdk.codeartsbuild.v3.*; import com.huaweicloud.sdk.codeartsbuild.v3.model.*; public class ListGroupTreeSolution { 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); CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>")) .build(); ListGroupTreeRequest request = new ListGroupTreeRequest(); request.withProjectId("{project_id}"); try { ListGroupTreeResponse response = client.listGroupTree(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 huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsbuild.v3 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 = CodeArtsBuildClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListGroupTreeRequest() request.project_id = "{project_id}" response = client.list_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" codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/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 := codeartsbuild.NewCodeArtsBuildClient( codeartsbuild.CodeArtsBuildClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListGroupTreeRequest{} request.ProjectId = "{project_id}" response, err := client.ListGroupTree(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 |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot