查询部署服务器(QueryBaremetalPxeServer)

API请求

URLs

GET zstack/v1/baremetal/pxeservers
GET zstack/v1/baremetal/pxeservers/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/baremetal/pxeservers?q=uuid=b56be5d49df637308e7db1ae725a311e

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/baremetal/pxeservers/fdefdaf042463cfb8939563c5f910c8f

可查询字段

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

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "90afdd2b218b376592a25421e396597e",
      "name": "test",
      "hostname": "127.0.0.1",
      "sshUsername": "root",
      "sshPassword": "password",
      "sshPort": 22.0,
      "storagePath": "/cloud_bm_cache",
      "dhcpInterface": "eth0",
      "dhcpRangeBegin": "10.0.0.1",
      "dhcpRangeEnd": "10.0.0.255",
      "dhcpRangeNetmask": "255.255.255.0",
      "state": "Enabled",
      "status": "Connected"
    }
  ]
}


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

#error


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

#inventories


名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.1.1
zoneUuid	String	区域UUID	3.1.1
name	String	资源名称	3.1.1
description	String	资源的详细描述	3.1.1
hostname	String	部署服务器地址	3.1.1
sshUsername	String	部署服务器SSH账户	3.1.1
sshPassword	String	部署服务器SSH密码	3.1.1
sshPort	Integer	部署服务器SSH端口	3.1.1
storagePath	String	部署服务器存储路径	3.1.1
dhcpInterface	String	DHCP请求监听网卡	3.1.1
dhcpRangeBegin	String	DHCP地址范围起始	3.1.1
dhcpRangeEnd	String	DHCP地址范围终止	3.1.1
dhcpRangeNetmask	String	DHCP子网掩码	3.1.1
state	String	部署服务器运行状态	3.1.1
status	String	部署服务器连接状态	3.1.1
createDate	Timestamp	创建时间	3.1.1
lastOpDate	Timestamp	最后一次修改时间	3.1.1
totalCapacity	Long	存储路径总容量	3.1.1
availableCapacity	Long	存储路径可用容量	3.1.1
attachedClusterUuids	List	部署服务器挂载集群UUID列表	3.1.1

SDK示例

Java SDK

QueryBaremetalPxeServerAction action = new QueryBaremetalPxeServerAction();
action.conditions = asList("uuid=543c0df623633fe0a0158e955b1a5702");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryBaremetalPxeServerAction.Result res = action.call();

Python SDK

QueryBaremetalPxeServerAction action = QueryBaremetalPxeServerAction()
action.conditions = ["uuid=a065f4830c9f301ead495e941ce7bd4e"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryBaremetalPxeServerAction.Result res = action.call()