更新KVM主机信息

PUT/zstack/v1/hosts/kvm/{uuid}/actions

Request

cURL

curl --request PUT \
  --url '/v1/hosts/kvm/{uuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/hosts/kvm/{uuid}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateKVMHost": {
    "username": "userName",
    "password": "password",
    "sshPort": 22
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateKVMHost":{"username":"userName","password":"password","sshPort":22}}' \
http://localhost:8080/zstack/v1/hosts/kvm/477399a02a343bf2971d86c531053f9e/actions

参数列表

名字	类型	位置	描述	起始版本
username (可选)	String	body(包含在updateKVMHost结构中)	用户名	0.6
password (可选)	String	body(包含在updateKVMHost结构中)	密码	0.6
sshPort (可选)	Integer	body(包含在updateKVMHost结构中)	ssh端口号	0.6
uuid	String	url	资源的UUID，唯一标示该资源	0.6
name (可选)	String	body(包含在updateKVMHost结构中)	资源名称	0.6
description (可选)	String	body(包含在updateKVMHost结构中)	资源的详细描述	0.6
managementIp (可选)	String	body(包含在updateKVMHost结构中)	管理节点IP	0.6
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.6

API返回

返回示例

{
  "inventory": {
    "zoneUuid": "82c01885efdc3f789fa9130db6a00532",
    "name": "example",
    "uuid": "b3b5a4d4c6973932a29d4bee698fe9ca",
    "clusterUuid": "c416a848e4e538f1b321169001869bbd",
    "description": "example",
    "managementIp": "192.168.0.1",
    "hypervisorType": "KVM",
    "state": "Enabled",
    "status": "Connected",
    "totalCpuCapacity": 4,
    "availableCpuCapacity": 2,
    "totalMemoryCapacity": 4,
    "availableMemoryCapacity": 4
  }
}

名字	类型	描述	起始版本
success	boolean		0.6
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventory	HostInventory	详情参考inventory	0.6

error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

inventory

名字	类型	描述	起始版本
zoneUuid	String	数据中心UUID	0.6
name	String	资源名称	0.6
uuid	String	资源的UUID，唯一标示该资源	0.6
clusterUuid	String	集群UUID	0.6
description	String	资源的详细描述	0.6
managementIp	String		0.6
hypervisorType	String		0.6
state	String		0.6
status	String		0.6
totalCpuCapacity	Long		0.6
availableCpuCapacity	Long		0.6
cpuSockets	Integer		0.6
totalMemoryCapacity	Long		0.6
availableMemoryCapacity	Long		0.6
cpuNum	Integer		0.6
ipmiAddress	String	IPMI地址	0.6
ipmiUsername	String	IPMI用户名	0.6
ipmiPort	Integer	IPMI端口	0.6
ipmiPowerStatus	String	IPMI电源状态	0.6
architecture	String		0.6
nqn	String	NVMe 限定名称	4.10.6
hostname	String	主机名	4.10.20
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
cpuStatus	HwMonitorStatus	详情参考cpuStatus	4.10.0
memoryStatus	HwMonitorStatus	详情参考memoryStatus	4.10.0
diskStatus	HwMonitorStatus	详情参考diskStatus	4.10.0
nicStatus	HwMonitorStatus	详情参考nicStatus	4.10.0
gpuStatus	HwMonitorStatus	详情参考gpuStatus	4.10.0
powerSupplyStatus	HwMonitorStatus	详情参考powerSupplyStatus	4.10.0
fanStatus	HwMonitorStatus	详情参考fanStatus	4.10.0
raidStatus	HwMonitorStatus	详情参考raidStatus	4.10.0
temperatureStatus	HwMonitorStatus	详情参考temperatureStatus	4.10.0

cpuStatus

名字	类型	描述	起始版本
Normal	HwMonitorStatus	正常	4.10.0
Error	HwMonitorStatus	异常	4.10.0
Unknown	HwMonitorStatus	未知	4.10.0

memoryStatus

名字	类型	描述	起始版本
Normal	HwMonitorStatus	正常	4.10.0
Error	HwMonitorStatus	异常	4.10.0
Unknown	HwMonitorStatus	未知	4.10.0

diskStatus

名字	类型	描述	起始版本
Normal	HwMonitorStatus	正常	4.10.0
Error	HwMonitorStatus	异常	4.10.0
Unknown	HwMonitorStatus	未知	4.10.0

nicStatus

名字	类型	描述	起始版本
Normal	HwMonitorStatus	正常	4.10.0
Error	HwMonitorStatus	异常	4.10.0
Unknown	HwMonitorStatus	未知	4.10.0

gpuStatus

名字	类型	描述	起始版本
Normal	HwMonitorStatus	正常	4.10.0
Error	HwMonitorStatus	异常	4.10.0
Unknown	HwMonitorStatus	未知	4.10.0

powerSupplyStatus

名字	类型	描述	起始版本
Normal	HwMonitorStatus	正常	4.10.0
Error	HwMonitorStatus	异常	4.10.0
Unknown	HwMonitorStatus	未知	4.10.0

fanStatus

名字	类型	描述	起始版本
Normal	HwMonitorStatus	正常	4.10.0
Error	HwMonitorStatus	异常	4.10.0
Unknown	HwMonitorStatus	未知	4.10.0

raidStatus

名字	类型	描述	起始版本
Normal	HwMonitorStatus	正常	4.10.0
Error	HwMonitorStatus	异常	4.10.0
Unknown	HwMonitorStatus	未知	4.10.0

temperatureStatus

名字	类型	描述	起始版本
Normal	HwMonitorStatus	正常	4.10.0
Error	HwMonitorStatus	异常	4.10.0
Unknown	HwMonitorStatus	未知	4.10.0

SDK示例

Java SDK

UpdateKVMHostAction action = new UpdateKVMHostAction();
action.username = "userName";
action.password = "password";
action.sshPort = 22;
action.uuid = "477399a02a343bf2971d86c531053f9e";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateKVMHostAction.Result res = action.call();

Python SDK

action = UpdateKVMHostAction()
action.username = "userName"
action.password = "password"
action.sshPort = 22
action.uuid = "477399a02a343bf2971d86c531053f9e"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()