ZStack ZSphere 4.10.10>ZStack ZSphere Documentation>ZStack ZSphere 开发手册>存储服务

存储服务

添加 ZStone(AddZStoneStorage)

API请求

URLs

POST zstack/v1/zstone-plugin

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "name": "zstone-storage",     "username": "admin",     "managementIp": "172.0.0.1",     "logInPort": 4000,     "apiPort": 4010,     "logInUrl": "/sso/v1/accounts/login"   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"zstone-storage","username":"admin","managementIp":"172.0.0.1","logInPort":4000,"apiPort":4010,"logInUrl":"/sso/v1/accounts/login"}}' \ http://localhost:8080/zstack/v1/zstone-plugin

参数列表

名字	类型	位置	描述	起始版本
name	String	body(包含在`params`结构中)	在 ZSphere 中这个 ZStone-Storage 的名称	4.10.6
username (可选)	String	body(包含在`params`结构中)	登录使用的用户名，一般是 admin	4.10.6
password (可选)	String	body(包含在`params`结构中)	登录使用的密码	4.10.6
managementIp	String	body(包含在`params`结构中)	ZStone 的管理节点 IP	4.10.6
logInPort (可选)	int	body(包含在`params`结构中)	ZStone 登录服务端口	4.10.6
apiPort (可选)	int	body(包含在`params`结构中)	ZStone API 服务端口	4.10.6
logInUrl (可选)	String	body(包含在`params`结构中)	ZStone 登录使用 URL	4.10.6
resourceUuid (可选)	String	body(包含在`params`结构中)	资源UUID	4.10.6
tagUuids (可选)	List	body(包含在`params`结构中)	标签UUID列表	4.10.6
systemTags (可选)	List	body	系统标签	4.10.6
userTags (可选)	List	body	用户标签	4.10.6

API返回

返回示例

{   "inventory": {     "uuid": "53c0433a817349f89f66532addeb8b6c",     "name": "zstone-plugin",     "username": "admin",     "managementIp": "127.0.0.1",     "authorizationServer": "Local",     "logInPort": 4000,     "apiPort": 4010,     "logInUrl": "/sso/v1/accounts/login",     "createDate": "Nov 14, 2017 2:20:57 PM",     "lastOpDate": "Nov 14, 2017 2:20:57 PM"   } }

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

#error

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

SDK示例

Java SDK

AddZStoneAction action = new AddZStoneAction(); action.name = "zstone-storage"; action.username = "admin"; action.managementIp = "172.0.0.1"; action.logInPort = 4000; action.apiPort = 4010; action.logInUrl = "/sso/v1/accounts/login"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; AddZStoneAction.Result res = action.call();

Python SDK

AddZStoneAction action = AddZStoneAction() action.name = "zstone-storage" action.username = "admin" action.managementIp = "172.0.0.1" action.logInPort = 4000 action.apiPort = 4010 action.logInUrl = "/sso/v1/accounts/login" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" AddZStoneAction.Result res = action.call()

移除 ZStone(RemoveZStone)

API请求

URLs

DELETE zstack/v1/zstone-plugin/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X DELETE http://localhost:8080/zstack/v1/zstone-plugin/53c0433a817349f89f66532addeb8b6c

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	ZStone 的 UUID，唯一标示该资源	4.10.6
deleteMode (可选)	String	body	删除模式(Permissive / Enforcing，Permissive)	4.10.6
systemTags (可选)	List	body	系统标签	4.10.6
userTags (可选)	List	body	用户标签	4.10.6

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{ 	"error": { 		"code": "SYS.1001", 		"description": "A message or a operation timeout", 		"details": "Create VM on KVM timeout after 300s" 	} }

SDK示例

Java SDK

RemoveZStoneAction action = new RemoveZStoneAction(); action.uuid = "53c0433a817349f89f66532addeb8b6c"; action.deleteMode = "Permissive"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; RemoveZStoneAction.Result res = action.call();

Python SDK

RemoveZStoneAction action = RemoveZStoneAction() action.uuid = "53c0433a817349f89f66532addeb8b6c" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" RemoveZStoneAction.Result res = action.call()

配置ZStone集群(UpdateZStoneClusterConfig)

API请求

URLs

PUT zstack/v1/zstone-plugin/config/cluster

Headers

Authorization: OAuth the-session-uuid

Body

{   "updateZStoneClusterConfig": {     "uuid": "53c0433a817349f89f66532addeb8b6c",     "clusterName": "zstone-test",     "chronyIp": "172.26.30.113",     "publicNetworkCidr": "172.26.0.1/16",     "clusterNetworkCidr": "172.26.0.1/16",     "managementNetworkCidr": "172.26.0.1/16",     "force": false   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X PUT -d '{"updateZStoneClusterConfig":{"uuid":"53c0433a817349f89f66532addeb8b6c","clusterName":"zstone-test","chronyIp":"172.26.30.113","publicNetworkCidr":"172.26.0.1/16","clusterNetworkCidr":"172.26.0.1/16","managementNetworkCidr":"172.26.0.1/16","force":false}}' \ http://localhost:8080/zstack/v1/zstone-plugin/config/cluster

参数列表

名字	类型	位置	描述	起始版本
uuid	String	body(包含在`updateZStoneClusterConfig`结构中)	ZStone 的 UUID，唯一标示该资源	4.10.6
clusterName	String	body(包含在`updateZStoneClusterConfig`结构中)	ZStone 的集群名称	4.10.6
managementIp (可选)	String	body(包含在`updateZStoneClusterConfig`结构中)	ZStone 的管理节点 IP	4.10.6
chronyIp	String	body(包含在`updateZStoneClusterConfig`结构中)	ZStone 的时间同步服务器 IP	4.10.6
publicNetworkCidr	String	body(包含在`updateZStoneClusterConfig`结构中)	ZStone 的公有网络 IP CIDR	4.10.6
clusterNetworkCidr	String	body(包含在`updateZStoneClusterConfig`结构中)	ZStone 的集群使用网络 IP CIDR	4.10.6
managementNetworkCidrv	String	body(包含在`updateZStoneClusterConfig`结构中)	ZStone 的管理网络 IP CIDR	4.10.6
systemTags (可选)	List	body	系统标签	4.10.6
userTags (可选)	List	body	用户标签	4.10.6
force (可选)	boolean	body(包含在`updateZStoneClusterConfig`结构中)	是否强制添加 ZStone 集群. 一般情况下, ZStone 已有集群后再添加集群会出现意想不到的问题, 因此这里做了防呆	4.10.7

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{ 	"error": { 		"code": "SYS.1001", 		"description": "A message or a operation timeout", 		"details": "Create VM on KVM timeout after 300s" 	} }

SDK示例

Java SDK

UpdateZStoneClusterConfigAction action = new UpdateZStoneClusterConfigAction(); action.uuid = "53c0433a817349f89f66532addeb8b6c"; action.clusterName = "zstone-test"; action.chronyIp = "172.26.30.113"; action.publicNetworkCidr = "172.26.0.1/16"; action.clusterNetworkCidr = "172.26.0.1/16"; action.managementNetworkCidr = "172.26.0.1/16"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; UpdateZStoneClusterConfigAction.Result res = action.call();

Python SDK

UpdateZStoneHostConfigAction action = UpdateZStoneHostConfigAction() action.uuid = "53c0433a817349f89f66532addeb8b6c" action.hostPort = 22 action.hosts = [[uuid:11045d20c4ae4d079b68d9aa9bd93e45, managementIp:172.30.3.21, publicIp:192.168.4.21], [uuid:f76c6667db6a4c0bb220b895478effcc, managementIp:172.30.3.22, publicIp:192.168.4.22], [uuid:0f7f889aebf0575bb223fc4f547854ef, managementIp:172.30.3.23, publicIp:192.168.4.23]] action.deployChrony = false action.copySshKey = true action.installWatch = true action.updateHostname = true action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" UpdateZStoneHostConfigAction.Result res = action.call()