Creating a Host (Recommended)
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group_id |
Yes |
String |
Host cluster ID |
Request 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. |
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.) |
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
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" }
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 CreateHostSolution { 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(); CreateHostRequest request = new CreateHostRequest(); request.withGroupId("{group_id}"); CreateHostRequestBody body = new CreateHostRequestBody(); HostAuthorizationBody authorizationbody = new HostAuthorizationBody(); authorizationbody.withUsername("root") .withPassword("*****") .withPrivateKey("") .withTrustedType(HostAuthorizationBody.TrustedTypeEnum.NUMBER_0); body.withInstallIcagent(true); body.withAuthorization(authorizationbody); body.withProxyHostId(""); body.withAsProxy(false); body.withOs(CreateHostRequestBody.OsEnum.fromValue("linux")); body.withPort(22); body.withIp("100.101.28.215"); body.withHostName("100.101.28.215"); request.withBody(body); try { CreateHostResponse response = client.createHost(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 = CreateHostRequest() request.group_id = "{group_id}" authorizationbody = HostAuthorizationBody( username="root", password="*****", private_key="", trusted_type=0 ) request.body = CreateHostRequestBody( 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_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.CreateHostRequest{} request.GroupId = "{group_id}" passwordAuthorization:= "*****" privateKeyAuthorization:= "" authorizationbody := &model.HostAuthorizationBody{ Username: "root", Password: &passwordAuthorization, PrivateKey: &privateKeyAuthorization, TrustedType: model.GetHostAuthorizationBodyTrustedTypeEnum().E_0, } installIcagentCreateHostRequestBody:= true proxyHostIdCreateHostRequestBody:= "" request.Body = &model.CreateHostRequestBody{ InstallIcagent: &installIcagentCreateHostRequestBody, Authorization: authorizationbody, ProxyHostId: &proxyHostIdCreateHostRequestBody, AsProxy: false, Os: model.GetCreateHostRequestBodyOsEnum().LINUX, Port: int32(22), Ip: "100.101.28.215", HostName: "100.101.28.215", } response, err := client.CreateHost(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.
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