Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Hosts/ Editing Host Information in a Host Cluster
Updated on 2025-08-18 GMT+08:00

Editing Host Information in a Host Cluster

Function

This API is used to edit host information in a host cluster by ID.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/resources/host-groups/{group_id}/hosts/{host_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

String

Host cluster ID

host_id

Yes

String

Host ID

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

as_proxy

No

Boolean

Proxy host or not

authorization

No

DeploymentHostAuthorizationBody object

Definition:

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

Constraints:

N/A.

host_name

Yes

String

Host name

ip

Yes

String

An IPv4 or IPv6 IP address.

port

Yes

Integer

SSH Port, for example, 22.

proxy_host_id

No

String

Proxy host ID

sync

No

Boolean

Whether to sync host information

install_icagent

No

Boolean

Whether to install ICAgent

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

status

String

Definition:

Request status (successful or failed).

Value range:

  • success: Successful.

  • error: Failed.

id

String

Definition:

Host ID.

Value range:

32 characters, including letters and digits.

Example Requests

https://{endpoint}/v1/resources/host-groups/6bec5f67ab9b4c34a21c7ffe0b0191c8/hosts/a94facdc4b1e40d799dbe6de91167072

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

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "id" : "a94facdc4b1e40d799dbe6de91167072"
}

SDK Sample Code

The SDK sample code is as follows.

Java

 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 UpdateHostInfoSolution {

    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();
        UpdateHostInfoRequest request = new UpdateHostInfoRequest();
        request.withGroupId("{group_id}");
        request.withHostId("{host_id}");
        DeploymentHostRequestExternal body = new DeploymentHostRequestExternal();
        DeploymentHostAuthorizationBody authorizationbody = new DeploymentHostAuthorizationBody();
        authorizationbody.withUsername("root")
            .withPassword("*****")
            .withPrivateKey("")
            .withTrustedType(DeploymentHostAuthorizationBody.TrustedTypeEnum.NUMBER_0);
        body.withInstallIcagent(true);
        body.withProxyHostId("");
        body.withPort(22);
        body.withIp("100.101.28.215");
        body.withHostName("hostName");
        body.withAuthorization(authorizationbody);
        body.withAsProxy(false);
        request.withBody(body);
        try {
            UpdateHostInfoResponse response = client.updateHostInfo(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

 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 = UpdateHostInfoRequest()
        request.group_id = "{group_id}"
        request.host_id = "{host_id}"
        authorizationbody = DeploymentHostAuthorizationBody(
            username="root",
            password="*****",
            private_key="",
            trusted_type=0
        )
        request.body = DeploymentHostRequestExternal(
            install_icagent=True,
            proxy_host_id="",
            port=22,
            ip="100.101.28.215",
            host_name="hostName",
            authorization=authorizationbody,
            as_proxy=False
        )
        response = client.update_host_info(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

 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
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.UpdateHostInfoRequest{}
	request.GroupId = "{group_id}"
	request.HostId = "{host_id}"
	passwordAuthorization:= "*****"
	privateKeyAuthorization:= ""
	authorizationbody := &model.DeploymentHostAuthorizationBody{
		Username: "root",
		Password: &passwordAuthorization,
		PrivateKey: &privateKeyAuthorization,
		TrustedType: model.GetDeploymentHostAuthorizationBodyTrustedTypeEnum().E_0,
	}
	installIcagentDeploymentHostRequestExternal:= true
	proxyHostIdDeploymentHostRequestExternal:= ""
	asProxyDeploymentHostRequestExternal:= false
	request.Body = &model.DeploymentHostRequestExternal{
		InstallIcagent: &installIcagentDeploymentHostRequestExternal,
		ProxyHostId: &proxyHostIdDeploymentHostRequestExternal,
		Port: int32(22),
		Ip: "100.101.28.215",
		HostName: "hostName",
		Authorization: authorizationbody,
		AsProxy: &asProxyDeploymentHostRequestExternal,
	}
	response, err := client.UpdateHostInfo(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.