Updated on 2026-02-09 GMT+08:00

Creating a Host Cluster

Function

This API is used to create a host cluster in a project. This API will not be maintained after September 30, 2024. You can use the CreateHostCluster API instead.

Calling Method

For details, see Calling APIs.

URI

POST /v2/host-groups

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

Message body type or format.

Constraints

N/A

Range

N/A

Default value

application/json.

X-Auth-Token

Yes

String

Definition :

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used for Obtaining a User Token.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition:

Host cluster name.

Constraints:

N/A.

Value range:

3 to 128 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

Default value:

N/A.

region_name

Yes

String

Definition

Region ID. For details, see Region.

Constraints

N/A

Range

The value can contain a maximum of 255 characters, including only letters, digits, hyphens (-), and underscores (_).

Default value

N/A

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are supported.

Default value

N/A

os

Yes

String

Definition:

OS of the host cluster.

Constraints:

N/A.

Value range:

  • window: Windows OS.

  • linux: Linux OS.

Default value:

N/A.

slave_cluster_id

No

String

Definition

Slave cluster ID. It is empty by default. When it is empty, the default agent pool is used.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are supported.

Default value

N/A

description

No

String

Definition:

Host cluster description.

Constraints:

N/A.

Value range:

String. 0 to 500 characters.

Default value:

N/A.

is_proxy_mode

No

Integer

Definition

Whether the host cluster is in the agent mode.

Constraints

N/A

Range

  • 0: Non-agent-mode host cluster.

  • 1: Agent-mode host cluster.

Default value

1.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

group_id

String

Definition:

Host cluster ID.

Value range:

32 characters, including letters and digits.

Example Requests

When creating a host cluster, you need to enter basic information, including the host cluster name, description, operating system, and whether be proxy access mode.

https://{endpoint}/v2/host-groups

{
  "name" : "test123",
  "description" : "",
  "region_name" : "region-a",
  "project_id" : "6039d4480efc4dddb178abff98719913",
  "os" : "linux",
  "slave_cluster_id" : "",
  "is_proxy_mode" : 1
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "group_id" : "f3938bd63e354d2bb9d9cf7b5dc3bf95"
}

SDK Sample Code

The SDK sample code is as follows.

Java

When creating a host cluster, you need to enter basic information, including the host cluster name, description, operating system, and whether be proxy access mode.

 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
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.codeartsdeploy.v2.region.CodeArtsDeployRegion;
import com.huaweicloud.sdk.codeartsdeploy.v2.*;
import com.huaweicloud.sdk.codeartsdeploy.v2.model.*;


public class CreateDeploymentGroupSolution {

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

        CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateDeploymentGroupRequest request = new CreateDeploymentGroupRequest();
        DeploymentGroup body = new DeploymentGroup();
        body.withIsProxyMode(1);
        body.withDescription("");
        body.withSlaveClusterId("");
        body.withOs(DeploymentGroup.OsEnum.fromValue("linux"));
        body.withProjectId("6039d4480efc4dddb178abff98719913");
        body.withRegionName("region-a");
        body.withName("test123");
        request.withBody(body);
        try {
            CreateDeploymentGroupResponse response = client.createDeploymentGroup(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

When creating a host cluster, you need to enter basic information, including the host cluster name, description, operating system, and whether be proxy access mode.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsdeploy.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 = CodeArtsDeployClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateDeploymentGroupRequest()
        request.body = DeploymentGroup(
            is_proxy_mode=1,
            description="",
            slave_cluster_id="",
            os="linux",
            project_id="6039d4480efc4dddb178abff98719913",
            region_name="region-a",
            name="test123"
        )
        response = client.create_deployment_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)

Go

When creating a host cluster, you need to enter basic information, including the host cluster name, description, operating system, and whether be proxy access mode.

 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 main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/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 := codeartsdeploy.NewCodeArtsDeployClient(
        codeartsdeploy.CodeArtsDeployClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateDeploymentGroupRequest{}
	isProxyModeDeploymentGroup:= int32(1)
	descriptionDeploymentGroup:= ""
	slaveClusterIdDeploymentGroup:= ""
	request.Body = &model.DeploymentGroup{
		IsProxyMode: &isProxyModeDeploymentGroup,
		Description: &descriptionDeploymentGroup,
		SlaveClusterId: &slaveClusterIdDeploymentGroup,
		Os: model.GetDeploymentGroupOsEnum().LINUX,
		ProjectId: "6039d4480efc4dddb178abff98719913",
		RegionName: "region-a",
		Name: "test123",
	}
	response, err := client.CreateDeploymentGroup(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

OK: The request is successful.

Error Codes

See Error Codes.