修改主机
功能介绍
根据主机id修改主机信息。该接口于2024年9月30日后不再维护。
调用方法
请参见如何调用API。
URI
PUT /v2/host-groups/{group_id}/hosts/{host_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
String |
参数解释: 主机集群id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
host_id |
是 |
String |
参数解释: 主机id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
参数解释: 消息体的类型(格式)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串,长度不超过20000个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
host_name |
是 |
String |
参数解释: 主机名称。 约束限制: 不涉及。 取值范围: 只能由中文字符、英文字母、数字及"-"、"_"、"."组成,且长度为[3-128]个字符。 默认取值: 不涉及。 |
ip |
是 |
String |
参数解释: 主机IP。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
port |
是 |
Integer |
参数解释: 主机ssh端口。 约束限制: 不涉及。 取值范围: 0-65535。 默认取值: 不涉及。 |
as_proxy |
是 |
Boolean |
参数解释: 是否是代理机。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
proxy_host_id |
否 |
String |
参数解释: 代理机id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
authorization |
是 |
参数解释: 登录主机鉴权,使用密码登录则填写密码即可,使用密钥则填写密钥,二选一即可。 约束限制: 不涉及。 |
|
install_icagent |
否 |
Boolean |
参数解释: 是否安装icagent。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
sync |
否 |
Boolean |
参数解释: 是否将当前主机的密码信息同步到同一项目下其他主机集群中具有相同IP、用户名、端口的主机。 约束限制: 不涉及。 取值范围:
默认取值: false。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
username |
是 |
String |
参数解释: 登录主机用户名。 约束限制: 不涉及。 取值范围: 只能由字母、数字、下划线、中划线、点号、 @ 符号组成,长度[2-32]字符。 默认取值: 不涉及。 |
password |
否 |
String |
参数解释: 密码,认证类型为0时,密码必填。 约束限制: 不涉及。 取值范围: 不能包含空格、双引号和单引号,且长度[5-32]个字符。 默认取值: 不涉及。 |
private_key |
否 |
String |
参数解释: 密钥,认证类型为1时,密钥必填。 约束限制: 不涉及。 取值范围: 最大长度不超过5000个字符。 默认取值: 不涉及。 |
trusted_type |
是 |
Integer |
参数解释: 登录主机时认证类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
host_id |
String |
参数解释: 主机id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
请求示例
修改目标主机基本信息,信息包含主机名称、IP地址、端口等。
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" : "", "private_key" : null, "trusted_type" : 0 }, "install_icagent" : false, "sync" : true }
响应示例
状态码:200
OK 请求响应成功
{ "host_id" : "300d6d2e53624d0da08b182099ad10f7" }
SDK代码示例
SDK代码示例如下。
Java
修改目标主机基本信息,信息包含主机名称、IP地址、端口等。
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") .withPassword("") .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
修改目标主机基本信息,信息包含主机名称、IP地址、端口等。
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", password="", 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
修改目标主机基本信息,信息包含主机名称、IP地址、端口等。
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}" passwordAuthorization:= "" authorizationbody := &model.DeploymentHostAuthorizationBody{ Username: "root", Password: &passwordAuthorization, 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) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。