On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Hosts/ Creating a Host (Recommended)

Creating a Host (Recommended)

Updated on 2025-05-27 GMT+08:00

View PDF

Function

This API is used to create a host in a specified host cluster.

Calling Method

For details, see Calling APIs.

URI

POST /v1/resources/host-groups/{group_id}/hosts

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
group_id	Yes	String	Host cluster ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format).
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
host_name	Yes	String	Host name
ip	Yes	String	An IPv4 or IPv6 IP address.
port	Yes	Integer	SSH port, for example, 22.
os	Yes	String	Operating system: Windows or Linux, which must be the same as that of the host cluster.
as_proxy	Yes	Boolean	Proxy or not
proxy_host_id	No	String	Proxy ID
authorization	Yes	HostAuthorizationBody object	Log in to the host for authentication by password or key.
install_icagent	No	Boolean	Application Operations Management (AOM) is enabled for free to provide metric monitoring, log query, and alarm functions. (The ICAgent is automatically installed and supports only Huawei Cloud Linux hosts.)

**Table 4** HostAuthorizationBody
Parameter	Mandatory	Type	Description
username	Yes	String	Username. The value can contain letters, digits, hyphens (-), underscores (_), and periods (.).
password	No	String	Password. When the authentication type is 0, the password is mandatory.
private_key	No	String	Key. When the authentication type is 1, the key is mandatory.
trusted_type	Yes	Integer	Authentication type. 0 indicates password authentication, and 1 indicates key authentication.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
status	String	Request success or failure status
id	String	Host ID

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}/v1/resources/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.

{
  "status" : "success",
  "id" : "300d6d2e53624d0da08b182099ad10f7"
}

Status Codes


Status Code	Description
200	OK: The request is successful.

Error Codes

See Error Codes.

Parent topic: Managing Hosts

Previous topic: Managing Hosts

Next topic: Querying a Host List (Recommended)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel