Help Center/ CodeArts Build/ API Reference/ APIs/ Group Management/ Creating a Build Task Group
Updated on 2025-12-10 GMT+08:00

Creating a Build Task Group

Function

This API is used to create a build task group.

Calling Method

For details, see Calling APIs.

URI

POST /v1/job/{project_id}/group/create

Table 1 Path Parameters

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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

id

No

String

Primary key ID.

name

Yes

String

Group name.

project_id

No

String

CodeArts project ID. For details, seeObtaining a CodeArts Project ID.

parent_id

No

String

Parent group ID.

group_id

No

String

Task group ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

Array of result objects

Returned result.

error

String

Returned error message.

status

String

Returned status information.

Table 4 result

Parameter

Type

Description

id

String

Primary key ID.

name

String

Group name.

project_id

String

CodeArts project ID. ID of the project to which the build task belongs.

parent_id

String

Parent group ID.

group_id

String

Task group ID.

domain_id

String

Tenant ID.

ordinal

String

Group index.

create_user

String

Creator.

update_user

String

Modifier (the user who performs modification).

create_time

String

Creation time.

update_time

String

Modification time.

path_id

String

Group address ID.

Example Requests

POST https://{endpoint}/v1/job/{project_id}/group/create

{
  "project_id" : "b4d3971c3988463b865f6f920846149e",
  "name" : "New group-53994140",
  "parent_id" : "626c66e962e44ce680b168c409d0502a"
}

Example Responses

Status code: 200

OK

{
  "result" : [ {
    "id" : "70e158b6054e442893d7f5a79d34ce61",
    "domain_id" : "60021bab32fd450aa2cb89226f425e06",
    "project_id" : "923785f9674548259144259077bc6a98",
    "name" : "777 (Group testing)",
    "parent_id" : "b13c933bbc6f4d09a98ef09e4cc07e17",
    "path_id" : "b13c933bbc6f4d09a98ef09e4cc07e17.66936fb8ea74472dbe7b05a46a50e62c",
    "ordinal" : 2,
    "create_user" : "test1",
    "update_user" : "test1",
    "create_time" : "2025-06-05T07:31:13+0800",
    "update_time" : "2025-06-09T09:40:58+0800"
  } ],
  "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
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.codeartsbuild.v3.region.CodeArtsBuildRegion;
import com.huaweicloud.sdk.codeartsbuild.v3.*;
import com.huaweicloud.sdk.codeartsbuild.v3.model.*;


public class CreateJobGroupSolution {

    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();
        CreateJobGroupRequest request = new CreateJobGroupRequest();
        request.withProjectId("{project_id}");
        JobGroupRequestBody body = new JobGroupRequestBody();
        body.withParentId("626c66e962e44ce680b168c409d0502a");
        body.withProjectId("b4d3971c3988463b865f6f920846149e");
        body.withName("New group-53994140");
        request.withBody(body);
        try {
            CreateJobGroupResponse response = client.createJobGroup(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
32
33
34
35
36
# 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 = CreateJobGroupRequest()
        request.project_id = "{project_id}"
        request.body = JobGroupRequestBody(
            parent_id="626c66e962e44ce680b168c409d0502a",
            project_id="b4d3971c3988463b865f6f920846149e",
            name="New group-53994140"
        )
        response = client.create_job_group(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
37
38
39
40
41
42
43
44
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.CreateJobGroupRequest{}
	request.ProjectId = "{project_id}"
	parentIdJobGroupRequestBody:= "626c66e962e44ce680b168c409d0502a"
	projectIdJobGroupRequestBody:= "b4d3971c3988463b865f6f920846149e"
	nameJobGroupRequestBody:= "New group-53994140"
	request.Body = &model.JobGroupRequestBody{
		ParentId: &parentIdJobGroupRequestBody,
		ProjectId: &projectIdJobGroupRequestBody,
		Name: &nameJobGroupRequestBody,
	}
	response, err := client.CreateJobGroup(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.