文档首页> 部署 CodeArts Deploy> API参考> API> 主机管理> 编辑主机集群下主机信息
更新时间:2024-06-27 GMT+08:00
分享

编辑主机集群下主机信息

功能介绍

根据主机id编辑主机集群下主机信息。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

group_id

String

主机集群id

最小长度:32

最大长度:32

host_id

String

主机id

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json

缺省值:application/json;charset=utf-8

枚举值:

  • application/json;charset=utf-8

  • application/json

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

最小长度:0

最大长度:20000

表3 请求Body参数

参数

是否必选

参数类型

描述

as_proxy

Boolean

是否为代理主机

authorization

DeploymentHostAuthorizationBody object

登录主机鉴权,使用密码登录则填写密码即可,使用密钥则填写密钥,二选一即可。

host_name

String

主机名称

最小长度:3

最大长度:128

ip

String

主机ip,如:161.17.101.12

最小长度:0

最大长度:128

port

Integer

ssh端口,如:22

最小值:0

最大值:65535

proxy_host_id

String

代理主机id

最小长度:32

最大长度:32

sync

Boolean

是否同步主机信息

install_icagent

Boolean

是否安装icAgent

表4 DeploymentHostAuthorizationBody

参数

是否必选

参数类型

描述

username

String

用户名,可输入中英文,数字和符号(-_.)。

最小长度:3

最大长度:128

password

String

密码,认证类型为0时,密码必填。

private_key

String

密钥,认证类型为1时,密钥必填

最小长度:1

最大长度:5000

trusted_type

Integer

认证类型,0表示使用密码认证,1表示使用密钥认证

枚举值:

  • 0

  • 1

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

status

String

请求成功失败状态

id

String

主机id

最小长度:32

最大长度:32

请求示例

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
  }
}

响应示例

状态码: 200

OK 请求响应成功

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

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码

分享:

    相关文档

    相关产品