主机相关接口

ZStack ZSphere 4.10.0>ZStack ZSphere Documentation>ZStack ZSphere 开发手册>计算管理>主机相关接口

添加KVM主机(AddKVMHost)

API请求

URLs

POST zstack/v1/hosts/kvm

Headers

Authorization: OAuth the-session-uuid

Body

{ "params": { "username": "userName", "password": "password", "sshPort": 22, "name": "newHost", "managementIp": "127.0.0.1", "clusterUuid": "449c63f16f9144528d99315f903be36e"   }, "systemTags": [], "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"username":"userName","password":"password","sshPort":"22","name":"newHost","managementIp":"127.0.0.1","clusterUuid":"9adf394ca46432afb1218d220bf2925e"}}' \ http://localhost:8080/zstack/v1/hosts/kvm

参数列表

名字	类型	位置	描述	起始版本
username	String	body(包含在params结构中)	ssh用户名	0.6
password	String	body(包含在params结构中)	ssh密码	0.6
sshPort (可选)	int	body(包含在params结构中)	ssh端口号	0.6
name	String	body(包含在params结构中)	资源名称	0.6
description (可选)	String	body(包含在params结构中)	资源的详细描述	0.6
managementIp	String	body(包含在params结构中)	主机管理节点IP	0.6
clusterUuid	String	body(包含在params结构中)	集群UUID	0.6
resourceUuid (可选)	String	body(包含在params结构中)	资源UUID	0.6
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.6

说明:

ZStack ZSphere创建KVM主机时支持关闭EPT功能，SystemTags增加关闭EPT功能选项。
- 选项格式为：pageTableExtensionDisabled
- 例如：pageTableExtensionDisabled

API返回

返回示例

{ "inventory": { "zoneUuid": "d4160c59319c4642832e666514364a79", "name": "example", "uuid": "479e88bab7a647e3b066a724c8bb3b82", "clusterUuid": "42ade59801804602b9986b42fd103d1c", "description": "example", "managementIp": "192.168.0.1", "hypervisorType": "KVM", "state": "Enabled", "status": "Connected", "totalCpuCapacity": 4.0, "availableCpuCapacity": 2.0, "totalMemoryCapacity": 4.0, "availableMemoryCapacity": 4.0   } }

名字	类型	描述	起始版本
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
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

SDK示例

Java SDK

AddKVMHostAction action = new AddKVMHostAction(); action.username = "userName"; action.password = "password"; action.sshPort = 22; action.name = "newHost"; action.managementIp = "127.0.0.1"; action.clusterUuid = "03de4c2f2b5445b7a3ab5ba44930c4e8"; action.sessionId = "5354944d50634bed8088567b5d551e6f"; AddKVMHostAction.Result res = action.call();

Python SDK

AddKVMHostAction action = AddKVMHostAction() action.username = "userName" action.password = "password" action.sshPort = 22 action.name = "newHost" action.managementIp = "127.0.0.1" action.clusterUuid = "9fa355cc5434466cba6fb478b8559dad" action.sessionId = "d3770b6e43874065a1ff3cf127857e32" AddKVMHostAction.Result res = action.call()

删除主机(DeleteHost)

API请求

URLs

DELETE zstack/v1/hosts/{uuid}?deleteMode={deleteMode}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 999c480f7f344c3b803c3d74b82b7145" \ -X DELETE http://localhost:8080/zstack/v1/hosts/bb2e5125ac2c4b3680463d7aeaf57773?deleteMode=Permissive

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	0.6
deleteMode (可选)	String	body	删除模式(Permissive 或者 Enforcing，默认 Permissive)	0.6
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.6

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{     "error": {         "code": "SYS.1001",         "description": "A message or a operation timeout",         "details": "Create VM on KVM timeout after 300s"     } }

SDK示例

Java SDK

DeleteHostAction action = new DeleteHostAction(); action.uuid = "2d4b91d9831d4630bf113ea75f78cb7a"; action.deleteMode = "Permissive"; action.sessionId = "923c9089a5fd4ea5b9fbfc1dec5802e2"; DeleteHostAction.Result res = action.call();

Python SDK

DeleteHostAction action = DeleteHostAction() action.uuid = "f62a37111c154ec9afeaeb2700ebcfe6" action.deleteMode = "Permissive" action.sessionId = "2aa7f575d8654712ba985f4a36594f0a" DeleteHostAction.Result res = action.call()

查询主机(QueryHost)

API请求

URLs

GET zstack/v1/hosts GET zstack/v1/hosts/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 99a86d711f154752b52a7de2b3c43a63" \ -X GET http://localhost:8080/zstack/v1/hosts?q=uuid=66547f0fc9fd45d98f6b8482488f2993

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth bd46777b8a8c4616a64f0cdbcf1bf98e" \ -X GET http://localhost:8080/zstack/v1/hosts/bb582f21cfad4f61a2ab1ec062131b4a

可查询字段

运行CLI命令行工具，输入QueryHost并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{   "inventories": [     {       "zoneUuid": "37649b12f572303a883c19c4c7af0856",       "name": "example",       "uuid": "f7bae73b9874344b8766dfcdda48ad6e",       "clusterUuid": "d59c027b81fe3bbc9d78ef45f574febb",       "description": "example",       "managementIp": "192.168.0.1",       "hypervisorType": "KVM",       "state": "Enabled",       "status": "Connected",       "totalCpuCapacity": 4.0,       "availableCpuCapacity": 2.0,       "cpuSockets": 4.0,       "totalMemoryCapacity": 1840414720,       "availableMemoryCapacity": 1840414720,       "cpuNum": 4.0     }   ] }

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventories	List	详情参考inventories	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

#inventories

名字	类型	描述	起始版本
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	主机状态，包括： Enabled Disabled PreMaintenance Maintenance	0.6
status	String	Connecting Connected Disconnected	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
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

说明: 主机状态变更总结如下：

Enabled 可以转换到 Disabled, PreMaintenance；
Disabled 可以转换到 Enabled, PreMaintenance；
PreMaintenance 可以转换到 Disabled, Enabled, Maintenance；
Maintenance 可以转换到 Disabled, Enabled。

SDK示例

Java SDK

QueryHostAction action = new QueryHostAction(); action.conditions = asList("uuid=fb0510cd5bf04565be44c43da20169c7"); action.sessionId = "d69767ca64854cfb99960282fcdb8aed"; QueryHostAction.Result res = action.call();

Python SDK

QueryHostAction action = QueryHostAction() action.conditions = ["uuid=2ddc05f8f46b4d5ab40053fdb72ae69d"] action.sessionId = "96b183220af446c39d7cf2674761d85e" QueryHostAction.Result res = action.call()