更改网关节点启用状态(ChangeBareMetal2GatewayState)

API请求

URLs

PUT zstack/v1/baremetal2/gateways/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "changeBareMetal2GatewayState": {
    "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 '{"changeBareMetal2GatewayState":{"stateEvent":"enable"}}' http://localhost:8080/zstack/v1/baremetal2/gateways/45e9cf4edc7638eaad0ef5e2ca03a911/actions

参数列表

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

API返回

返回示例

{
  "inventory": {
    "username": "username",
    "password": "password",
    "sshPort": 22.0,
    "zoneUuid": "f7ee69031623443a82c3d1ad14e17216",
    "name": "BM_GATEWAY",
    "uuid": "3827d83852794e138019088f4e9e2371",
    "description": "This is a bare metal gateway.",
    "managementIp": "192.168.0.10",
    "state": "Enabled",
    "status": "Connected",
    "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	BareMetal2GatewayInventory	详情参考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

名字	类型	描述	起始版本
attachedClusterUuids	List	挂载集群的UUID列表	4.0.0
username	String	用户名	4.0.0
sshPort	Integer	SSH端口	4.0.0
zoneUuid	String	区域UUID	4.0.0
name	String	资源名称	4.0.0
uuid	String	资源的UUID，唯一标示该资源	4.0.0
clusterUuid	String	集群UUID	4.0.0
description	String	资源的详细描述	4.0.0
managementIp	String	管理网络IP地址	4.0.0
hypervisorType	String	虚拟化类型	4.0.0
state	String	启用状态	4.0.0
status	String	连接状态	4.0.0
totalCpuCapacity	Long	CPU总量	4.0.0
availableCpuCapacity	Long	CPU可用量	4.0.0
cpuSockets	Integer		4.0.0
totalMemoryCapacity	Long	内存总量	4.0.0
availableMemoryCapacity	Long	内存可用量	4.0.0
cpuNum	Integer	CPU核数	4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0
provisionNic	BareMetal2GatewayProvisionNicInventory	详情参考provisionNic	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

SDK示例

Java SDK

ChangeBareMetal2GatewayStateAction action = new ChangeBareMetal2GatewayStateAction();
action.uuid = "45e9cf4edc7638eaad0ef5e2ca03a911";
action.stateEvent = "enable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeBareMetal2GatewayStateAction.Result res = action.call();

Python SDK

ChangeBareMetal2GatewayStateAction action = ChangeBareMetal2GatewayStateAction()
action.uuid = "45e9cf4edc7638eaad0ef5e2ca03a911"
action.stateEvent = "enable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeBareMetal2GatewayStateAction.Result res = action.call()

上一篇查询网关节点(QueryBareMetal2Gateway)下一篇重连网关节点(ReconnectBareMetal2Gateway)