开发手册 | 5.5.30 | ZStack Cloud · ZCF

API请求

URLs

GET zstack/v1/baremetal2/provision-networks

GET zstack/v1/baremetal2/provision-networks/{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/provision-networks?q=uuid=b21a4853a2fe382081e2a3be5805e9a9

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

可查询字段

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

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "dc29aa53b5624dca835173938e8fee4b",
      "zoneUuid": "6f25b0e09f46488ba7c29d16a45a0257",
      "name": "BM_PROVISION_NETWORK",
      "description": "This is a bare metal provision network.",
      "dhcpInterface": "eth0",
      "dhcpRangeStartIp": "192.168.0.10",
      "dhcpRangeEndIp": "192.168.0.100",
      "dhcpRangeNetmask": "255.255.255.0",
      "dhcpRangeGateway": "192.168.0.1",
      "dhcpRangeNetworkCidr": "192.168.0.10/24",
      "state": "Enabled",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

名字	类型	描述	起始版本
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

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.0.0
zoneUuid	String	区域UUID	4.0.0
name	String	资源名称	4.0.0
description	String	资源的详细描述	4.0.0
dhcpInterface	String	DHCP监听网卡	4.0.0
dhcpRangeStartIp	String	DHCP起始IP地址	4.0.0
dhcpRangeEndIp	String	DHCP终止IP地址	4.0.0
dhcpRangeNetmask	String	子网掩码	4.0.0
dhcpRangeGateway	String	网关地址	4.0.0
dhcpRangeNetworkCidr	String	CIDR	4.0.0
state	String	状态	4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0
attachedClusterUuids	List		4.0.0

SDK示例

Java SDK

QueryBareMetal2ProvisionNetworkAction action = new QueryBareMetal2ProvisionNetworkAction();
action.conditions = asList("uuid=51b899bda0df3484be1c6bc1fbba68de");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryBareMetal2ProvisionNetworkAction.Result res = action.call();

Python SDK

QueryBareMetal2ProvisionNetworkAction action = QueryBareMetal2ProvisionNetworkAction()
action.conditions = ["uuid=07e9ed20cfc13057adee51036dc1687e"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryBareMetal2ProvisionNetworkAction.Result res = action.call()

查询部署网络(QueryBareMetal2ProvisionNetwork)

API请求

API返回

SDK示例