更改部署网络启用状态(ChangeBareMetal2ProvisionNetworkState)

API请求

URLs

PUT zstack/v1/baremetal2/provision-networks/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "changeBareMetal2ProvisionNetworkState": {
    "stateEvent": "enable"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeBareMetal2ProvisionNetworkState":{"stateEvent":"enable"}}' http://localhost:8080/zstack/v1/baremetal2/provision-networks/9d2b61e0abba3dd5830fe13bde6fc935/actions

参数列表

名字	类型	位置	描述	可选值	起始版本
uuid	String	url	资源的UUID，唯一标示该资源		4.0.0
stateEvent	String	body(包含在changeBareMetal2ProvisionNetworkState结构中)	状态事件	enable disable	4.0.0
systemTags (可选)	List	body	系统标签		4.0.0
userTags (可选)	List	body	用户标签		4.0.0

API返回

返回示例

{
  "inventory": {
    "uuid": "0f0a5bd7eaef49d2a4ddff9507afa4e8",
    "zoneUuid": "1d5a403dcfdb4b6fa581540579e5d5cb",
    "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
inventory	BareMetal2ProvisionNetworkInventory	详情参考inventory	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

#inventory

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

ChangeBareMetal2ProvisionNetworkStateAction action = new ChangeBareMetal2ProvisionNetworkStateAction();
action.uuid = "9d2b61e0abba3dd5830fe13bde6fc935";
action.stateEvent = "enable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeBareMetal2ProvisionNetworkStateAction.Result res = action.call();

Python SDK

ChangeBareMetal2ProvisionNetworkStateAction action = ChangeBareMetal2ProvisionNetworkStateAction()
action.uuid = "9d2b61e0abba3dd5830fe13bde6fc935"
action.stateEvent = "enable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeBareMetal2ProvisionNetworkStateAction.Result res = action.call()

上一篇查询部署网络(QueryBareMetal2ProvisionNetwork)下一篇将部署网络加载到弹性裸金属集群(AttachBareMetal2ProvisionNetworkToCluster)