通过弹性裸金属实例获取硬件信息(InspectBareMetal2ChassisByInstance)

API请求

URLs

PUT zstack/v1/baremetal2/bm-instances/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "inspectBareMetal2ChassisByInstance": {},
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"inspectBareMetal2ChassisByInstance":{}}' http://localhost:8080/zstack/v1/baremetal2/bm-instances/d40144a84b1633e8b2aacd333a7105d3/actions

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	5.2.0
systemTags (可选)	List	body	系统标签	5.2.0
userTags (可选)	List	body	用户标签	5.2.0

API返回

返回示例

{
  "inventory": {
    "uuid": "33ce10962f314b71be5b846cd7230af7",
    "name": "BM_CHASSIS",
    "description": "This is a bare metal chassis.",
    "zoneUuid": "d07b6968028a49e199373c51af1aca23",
    "clusterUuid": "3cb1198f2d964626ba1309a43d854610",
    "chassisOfferingUuid": "6f0ee825fd9a441885eebd70f0f9171c",
    "type": "IPMI",
    "state": "Enabled",
    "status": "Available",
    "powerStatus": "POWER_ON",
    "provisionType": "Remote",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM"
  }
}

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

#error

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

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.2.0
name	String	资源名称	5.2.0
description	String	资源的详细描述	5.2.0
zoneUuid	String	区域UUID	5.2.0
clusterUuid	String	集群UUID	5.2.0
chassisOfferingUuid	String	裸金属节点规格UUID	5.2.0
type	String	类型	5.2.0
state	String	启用状态	5.2.0
status	String	分配状态	5.2.0
powerStatus	String	电源状态	5.2.0
createDate	Timestamp	创建时间	5.2.0
lastOpDate	Timestamp	最后一次修改时间	5.2.0
chassisNics	List	详情参考chassisNics	5.2.0
chassisDisks	List	详情参考chassisDisks	5.2.0
chassisOffering	BareMetal2ChassisOfferingInventory	详情参考chassisOffering	5.2.0

#chassisNics

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.2.0
chassisUuid	String	裸金属节点UUID	5.2.0
mac	String	网卡MAC	5.2.0
speed	String	网卡速率	5.2.0
isProvisionNic	Boolean	是否为部署网卡	5.2.0
createDate	Timestamp	创建时间	5.2.0
lastOpDate	Timestamp	最后一次修改时间	5.2.0

#chassisDisks

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.2.0
chassisUuid	String	裸金属节点UUID	5.2.0
diskSize	Long	磁盘空间(以字节为单位)	5.2.0
type	String	磁盘类型	5.2.0
createDate	Timestamp	创建时间	5.2.0
lastOpDate	Timestamp	最后一次修改时间	5.2.0

#chassisOffering

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.2.0
name	String	资源名称	5.2.0
description	String	资源的详细描述	5.2.0
architecture	String	CPU架构	5.2.0
cpuModelName	String	CPU型号	5.2.0
cpuNum	Integer	CPU核数	5.2.0
memorySize	Long	内存容量	5.2.0
bootMode	String	启动模式	5.2.0
state	String	状态	5.2.0
createDate	Timestamp	创建时间	5.2.0
lastOpDate	Timestamp	最后一次修改时间	5.2.0

SDK示例

Java SDK

InspectBareMetal2ChassisByInstanceAction action = new InspectBareMetal2ChassisByInstanceAction();
action.uuid = "d40144a84b1633e8b2aacd333a7105d3";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
InspectBareMetal2ChassisByInstanceAction.Result res = action.call();

Python SDK

InspectBareMetal2ChassisByInstanceAction action = InspectBareMetal2ChassisByInstanceAction()
action.uuid = "d40144a84b1633e8b2aacd333a7105d3"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
InspectBareMetal2ChassisByInstanceAction.Result res = action.call()

上一篇检查部署IP是否可用(CheckStaticProvisionIp)下一篇创建裸金属实例Bond配置(CreateBareMetal2Bonding)