Updated on 2025-08-18 GMT+08:00

Creating a Host

Function

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

Calling Method

For details, see Calling APIs.

URI

POST /v2/host-groups/{group_id}/hosts

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

String

Definition:

Host cluster ID.

Constraints:

N/A.

Value range:

32 characters, including letters and digits.

Default value:

N/A.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition:

Type (or format) of the message body.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

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 forObtaining a User Token.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

host_name

Yes

String

Definition:

Host name.

Constraints:

N/A.

Value range:

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

Default value:

N/A.

ip

Yes

String

Definition:

Host IP address.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

port

Yes

Integer

Definition:

SSH port of the host.

Constraints:

N/A.

Value range:

0–65535.

Default value:

N/A.

os

Yes

String

Definition:

Host OS type.

Constraints:

N/A.

Value range:

  • window: Windows OS.

  • linux: Linux OS.

Default value:

N/A.

as_proxy

Yes

Boolean

Definition:

Agent or not.

Constraints:

N/A.

Value range:

  • true: Yes.

  • false: No.

Default value:

N/A.

proxy_host_id

No

String

Definition:

Agent ID.

Constraints:

N/A.

Value range:

32 characters, including letters and digits.

Default value:

N/A.

authorization

Yes

DeploymentHostAuthorizationBody object

Definition:

Log in to the host for authentication. Use either a password or key for login.

Constraints:

N/A.

install_icagent

No

Boolean

Definition:

Whether to install ICAgent.

Constraints:

N/A.

Value range:

  • true: Yes.

  • false: No.

Default value:

N/A.

Table 4 DeploymentHostAuthorizationBody

Parameter

Mandatory

Type

Description

username

Yes

String

Definition:

Username for logging in to the host.

Constraints:

N/A.

Value range:

2 to 32 characters, including letters, digits, underscores (_), hyphens (-), periods (.), and at signs (@).

Default value:

N/A.

password

No

String

Definition:

Password. Mandatory when the authentication type is 0.

Constraints:

N/A.

Value range:

5 to 32 characters. Spaces, single and double quotation marks are not supported.

Default value:

N/A.

private_key

No

String

Definition:

Key. Mandatory when the authentication type is 1.

Constraints:

N/A.

Value range:

Max. 5,000 characters.

Default value:

N/A.

trusted_type

Yes

Integer

Definition:

Authentication type for logging in to the host.

Constraints:

N/A.

Value range:

  • 0: Password authentication.

  • 1: Key authentication.

Default value:

N/A.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

host_id

String

Definition:

Host ID.

Value range:

32 characters, including letters and digits.

Example Requests

When creating a host, you need to enter the basic information about the host, including the host name, IP address, port number, username, and password.

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

{
  "host_name" : "100.101.28.215",
  "ip" : "100.101.28.215",
  "port" : "22",
  "os" : "linux",
  "as_proxy" : false,
  "proxy_host_id" : "",
  "authorization" : {
    "username" : "root",
    "password" : "*****",
    "private_key" : "",
    "trusted_type" : 0
  },
  "install_icagent" : true
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "host_id" : "300d6d2e53624d0da08b182099ad10f7"
}

SDK Sample Code

The SDK sample code is as follows.

Java

When creating a host, you need to enter the basic information about the host, including the host name, IP address, port number, username, and password.

 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
55
56
57
58
59
60
61
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 CreateDeploymentHostSolution {

    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();
        CreateDeploymentHostRequest request = new CreateDeploymentHostRequest();
        request.withGroupId("{group_id}");
        DeploymentHost body = new DeploymentHost();
        DeploymentHostAuthorizationBody authorizationbody = new DeploymentHostAuthorizationBody();
        authorizationbody.withUsername("root")
            .withPassword("*****")
            .withPrivateKey("")
            .withTrustedType(DeploymentHostAuthorizationBody.TrustedTypeEnum.NUMBER_0);
        body.withInstallIcagent(true);
        body.withAuthorization(authorizationbody);
        body.withProxyHostId("");
        body.withAsProxy(false);
        body.withOs(DeploymentHost.OsEnum.fromValue("linux"));
        body.withPort(22);
        body.withIp("100.101.28.215");
        body.withHostName("100.101.28.215");
        request.withBody(body);
        try {
            CreateDeploymentHostResponse response = client.createDeploymentHost(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, you need to enter the basic information about the host, including the host name, IP address, port number, username, and password.

 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
# 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 = CreateDeploymentHostRequest()
        request.group_id = "{group_id}"
        authorizationbody = DeploymentHostAuthorizationBody(
            username="root",
            password="*****",
            private_key="",
            trusted_type=0
        )
        request.body = DeploymentHost(
            install_icagent=True,
            authorization=authorizationbody,
            proxy_host_id="",
            as_proxy=False,
            os="linux",
            port=22,
            ip="100.101.28.215",
            host_name="100.101.28.215"
        )
        response = client.create_deployment_host(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, you need to enter the basic information about the host, including the host name, IP address, port number, username, and password.

 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
55
56
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.CreateDeploymentHostRequest{}
	request.GroupId = "{group_id}"
	passwordAuthorization:= "*****"
	privateKeyAuthorization:= ""
	authorizationbody := &model.DeploymentHostAuthorizationBody{
		Username: "root",
		Password: &passwordAuthorization,
		PrivateKey: &privateKeyAuthorization,
		TrustedType: model.GetDeploymentHostAuthorizationBodyTrustedTypeEnum().E_0,
	}
	installIcagentDeploymentHost:= true
	proxyHostIdDeploymentHost:= ""
	request.Body = &model.DeploymentHost{
		InstallIcagent: &installIcagentDeploymentHost,
		Authorization: authorizationbody,
		ProxyHostId: &proxyHostIdDeploymentHost,
		AsProxy: false,
		Os: model.GetDeploymentHostOsEnum().LINUX,
		Port: int32(22),
		Ip: "100.101.28.215",
		HostName: "100.101.28.215",
	}
	response, err := client.CreateDeploymentHost(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.