查询弹性裸金属实例(QueryBareMetal2Instance)

API请求

URLs

GET zstack/v1/baremetal2/bm-instances

GET zstack/v1/baremetal2/bm-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/baremetal2/bm-instances?q=uuid=36cd7d9df10737999a92f9ce1395842d

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

可查询字段

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

API返回

返回示例

{
  "inventories": [
    {
      "chassisUuid": "463018b125d742e8acb3d6a5412eb674",
      "lastChassisUuid": "5facc3e540e3464daef9dc123aae9f2b",
      "gatewayUuid": "2cdd33f2d2f14b599965b2b351c77c10",
      "lastGatewayUuid": "e96b15632b2d4975ae4252a8d33b3904",
      "chassisOfferingUuid": "db5d18b6551e4af492bda6cef97045e3",
      "status": "Connected",
      "uuid": "f6898853cff24b2a85c388f4c676d1a7",
      "name": "BM-1",
      "description": "This is a BareMetal2 Instance.",
      "zoneUuid": "8f741ad043a54c98a9729c3871cfc985",
      "clusterUuid": "1bf322359f0e41668a67e119fc2184d1",
      "imageUuid": "17ddfe24cce247f2a27a13ad78b1536a",
      "rootVolumeUuid": "e1551175153c4d4f89edfccf85e15fbe",
      "platform": "Linux",
      "type": "baremetal2",
      "memorySize": 8.589934592E9,
      "cpuNum": 8.0,
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM",
      "state": "Running"
    }
  ]
}

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

#error

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

#inventories

名字	类型	描述	起始版本
chassisUuid	String	裸金属节点UUID	4.0.0
lastChassisUuid	String	上次所在裸金属节点UUID	4.0.0
gatewayUuid	String	裸金属网关节点UUID	4.0.0
lastGatewayUuid	String	上次所在裸金属网关节点UUID	4.0.0
chassisOfferingUuid	String	裸金属节点规格UUID	4.0.0
gatewayAllocatorStrategy	String	裸金属网关节点分配策略	4.0.0
status	String	连接状态	4.0.0
uuid	String	资源的UUID，唯一标示该资源	4.0.0
name	String	资源名称	4.0.0
description	String	资源的详细描述	4.0.0
zoneUuid	String	区域UUID	4.0.0
clusterUuid	String	集群UUID	4.0.0
imageUuid	String	镜像UUID	4.0.0
rootVolumeUuid	String	根云盘UUID	4.0.0
platform	String	平台类型	4.0.0
defaultL3NetworkUuid	String	默认网络UUID	4.0.0
type	String	类型	4.0.0
hypervisorType	String	虚拟化类型	4.0.0
memorySize	Long	内存容量	4.0.0
cpuNum	Integer	CPU核数	4.0.0
cpuSpeed	Long	CPU速率	4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0
state	String	运行状态	4.0.0
provisionNic	BareMetal2InstanceProvisionNicInventory	详情参考provisionNic	4.0.0
vmNics	List	详情参考vmNics	4.0.0
allVolumes	List	详情参考allVolumes	4.0.0

#provisionNic

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.0.0
networkUuid	String	裸金属部署网络UUID	4.0.0
interfaceName	String	网卡名称	4.0.0
ip	String	IP地址	4.0.0
netmask	String	子网掩码	4.0.0
gateway	String	网关地址	4.0.0
metadata	String		4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0

#vmNics

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.0.0
vmInstanceUuid	String	云主机UUID	4.0.0
l3NetworkUuid	String	三层网络UUID	4.0.0
ip	String	IP地址	4.0.0
mac	String	MAC地址	4.0.0
hypervisorType	String	虚拟化类型	4.0.0
netmask	String	子网掩码	4.0.0
gateway	String	网关	4.0.0
metaData	String		4.0.0
ipVersion	Integer	IP地址版本	4.0.0
deviceId	Integer	设备ID	4.0.0
type	String	网卡类型	4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0
usedIps	List	详情参考usedIps	4.0.0

#usedIps

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.0.0
ipRangeUuid	String	IP段UUID	4.0.0
l3NetworkUuid	String	三层网络UUID	4.0.0
ipVersion	Integer	IP协议号	4.0.0
ip	String	IP地址	4.0.0
netmask	String	网络掩码	4.0.0
gateway	String	网关地址	4.0.0
usedFor	String		4.0.0
ipInLong	long		4.0.0
vmNicUuid	String	云主机网卡UUID	4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0

#allVolumes

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.0.0
name	String	资源名称	4.0.0
description	String	资源的详细描述	4.0.0
primaryStorageUuid	String	主存储UUID	4.0.0
vmInstanceUuid	String	云主机UUID	4.0.0
diskOfferingUuid	String	云盘规格UUID	4.0.0
rootImageUuid	String	云盘根镜像UUID	4.0.0
installPath	String	云盘在主存储上的路径	4.0.0
type	String	云盘类型，数据云盘/根云盘	4.0.0
format	String	云盘格式	4.0.0
size	Long	云盘大小	4.0.0
actualSize	Long	云盘真实大小	4.0.0
deviceId	Integer		4.0.0
state	String	云盘是否开启	4.0.0
status	String	云盘状态	4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0
isShareable	Boolean	是否共享云盘	4.0.0
volumeQos	String	云盘Qos，格式如total=1048576	4.0.0

SDK示例

Java SDK

QueryBareMetal2GatewayAction action = new QueryBareMetal2GatewayAction();
action.conditions = asList("uuid=089cc9f73e31367c8d3db89f736957b2");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryBareMetal2GatewayAction.Result res = action.call();

Python SDK

QueryBareMetal2GatewayAction action = QueryBareMetal2GatewayAction()
action.conditions = ["uuid=88779d1fce2138c28744a2ed1265df1d"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryBareMetal2GatewayAction.Result res = action.call()

上一篇更新弹性裸金属实例(UpdateBareMetal2Instance)下一篇修改弹性裸金属实例密码(ChangeBareMetal2InstancePassword)