查询裸机实例(QueryBaremetalInstance)

API请求

URLs

GET zstack/v1/baremetal/instances
GET zstack/v1/baremetal/instances/{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/instances?q=uuid = 93c50425e0ed3b2884027db70620db38

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

可查询字段

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

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "9d3a2dd0d48c3220a40a66a33874f25a",
      "name": "BM-1",
      "description": "This is a baremetal instance.",
      "zoneUuid": "4d1bf4f2ab113292808be87ad9ff553b",
      "clusterUuid": "e24ee969ccc83aa287713ec2dca4e8e0",
      "chassisUuid": "da16af4bb6c43b8fba2b5ba918e0cdbb",
      "imageUuid": "70ff9f3ae5863fcfab60999afdf55219",
      "platform": "Linux",
      "state": "Running",
      "status": "Provisioned",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM",
      "bmNics": [
        {
          "uuid": "8fb718abb0bd3ce99215d446cd6dba1d",
          "baremetalInstanceUuid": "9d3a2dd0d48c3220a40a66a33874f25a",
          "l3NetworkUuid": "8b40c2c7a19e3c96b4bca63b56909898",
          "mac": "6c:b3:11:1b:0b:1e",
          "ip": "192.168.0.10",
          "netmask": "255.255.255.0",
          "gateway": "192.168.0.1",
          "pxe": false
        }
      ]
    }
  ]
}


名字	类型	描述	起始版本
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，唯一标示该资源	2.6.0
name	String	资源名称	2.6.0
description	String	资源的详细描述	2.6.0
zoneUuid	String	区域UUID	2.6.0
clusterUuid	String	集群UUID	2.6.0
pxeServerUuid	String		3.1.1
chassisUuid	String	裸机设备UUID	2.6.0
imageUuid	String	镜像UUID	2.6.0
platform	String	系统平台	2.6.0
state	String		2.6.0
status	String		2.6.0
createDate	Timestamp	创建时间	2.6.0
lastOpDate	Timestamp	最后一次修改时间	2.6.0
bmNics	List	详情参考bmNics	2.6.0

#bmNics


名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	2.6.0
baremetalInstanceUuid	String	裸机实例UUID	2.6.0
l3NetworkUuid	String	三层网络UUID	2.6.0
baremetalBondingUuid	String	BOND UUID	3.4.0
mac	String	MAC地址	2.6.0
ip	String	IP地址	2.6.0
netmask	String	子网掩码	2.6.0
gateway	String	网关	2.6.0
metadata	String		2.6.0
pxe	Boolean	是否PXE启动网卡	2.6.0
createDate	Timestamp	创建时间	2.6.0
lastOpDate	Timestamp	最后一次修改时间	2.6.0

SDK示例

Java SDK

QueryBaremetalInstanceAction action = new QueryBaremetalInstanceAction();
action.conditions = asList("uuid = 7fac9998fb703185a8b6655af59d0d21");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryBaremetalInstanceAction.Result res = action.call();

Python SDK

QueryBaremetalInstanceAction action = QueryBaremetalInstanceAction()
action.conditions = ["uuid = a52323ca9c6132eeb0dc607570fb988f"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryBaremetalInstanceAction.Result res = action.call()