Updated on 2024-11-25 GMT+08:00

Modifying a Host

Function

This API is used to modify host information by ID. This API will not be maintained after September 30, 2024.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/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

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.

as_proxy

Yes

Boolean

Proxy or not

proxy_host_id

No

String

Proxy ID

authorization

Yes

DeploymentHostAuthorizationBody 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.)

sync

No

Boolean

Whether to sync the password of the current host to the hosts with the same IP address, username, and port number in other host clusters in the same project.

Table 4 DeploymentHostAuthorizationBody

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

host_id

String

Host ID

Example Requests

Modify the basic information about the target host, including the host name, IP address, and port number.

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

{
  "host_name" : "100.101.28.215",
  "ip" : "100.101.28.215",
  "port" : 22,
  "as_proxy" : false,
  "proxy_host_id" : null,
  "authorization" : {
    "username" : "root",
    "password" : null,
    "private_key" : "",
    "trusted_type" : 0
  },
  "install_icagent" : false,
  "sync" : 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

Modify the basic information about the target host, including the host name, IP address, and port number.

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

    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();
        UpdateDeploymentHostRequest request = new UpdateDeploymentHostRequest();
        request.withGroupId("{group_id}");
        request.withHostId("{host_id}");
        DeploymentHostRequest body = new DeploymentHostRequest();
        DeploymentHostAuthorizationBody authorizationbody = new DeploymentHostAuthorizationBody();
        authorizationbody.withUsername("root")
            .withPrivateKey("")
            .withTrustedType(DeploymentHostAuthorizationBody.TrustedTypeEnum.NUMBER_0);
        body.withHostName("100.101.28.215");
        body.withSync(true);
        body.withAsProxy(false);
        body.withInstallIcagent(false);
        body.withIp("100.101.28.215");
        body.withPort(22);
        body.withAuthorization(authorizationbody);
        request.withBody(body);
        try {
            UpdateDeploymentHostResponse response = client.updateDeploymentHost(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

Modify the basic information about the target host, including the host name, IP address, and port number.

 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
# 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 = UpdateDeploymentHostRequest()
        request.group_id = "{group_id}"
        request.host_id = "{host_id}"
        authorizationbody = DeploymentHostAuthorizationBody(
            username="root",
            private_key="",
            trusted_type=0
        )
        request.body = DeploymentHostRequest(
            host_name="100.101.28.215",
            sync=True,
            as_proxy=False,
            install_icagent=False,
            ip="100.101.28.215",
            port=22,
            authorization=authorizationbody
        )
        response = client.update_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

Modify the basic information about the target host, including the host name, IP address, and port number.

 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 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.UpdateDeploymentHostRequest{}
	request.GroupId = "{group_id}"
	request.HostId = "{host_id}"
	privateKeyAuthorization:= ""
	authorizationbody := &model.DeploymentHostAuthorizationBody{
		Username: "root",
		PrivateKey: &privateKeyAuthorization,
		TrustedType: model.GetDeploymentHostAuthorizationBodyTrustedTypeEnum().E_0,
	}
	syncDeploymentHostRequest:= true
	installIcagentDeploymentHostRequest:= false
	request.Body = &model.DeploymentHostRequest{
		HostName: "100.101.28.215",
		Sync: &syncDeploymentHostRequest,
		AsProxy: false,
		InstallIcagent: &installIcagentDeploymentHostRequest,
		Ip: "100.101.28.215",
		Port: int32(22),
		Authorization: authorizationbody,
	}
	response, err := client.UpdateDeploymentHost(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.