ZStack ZSphere 4.10.0>ZStack Cloud ZStack ZSphere产品文档>ZStack ZSphere 开发手册>系统管理>用户配置相关接口

系统管理

用户配置相关接口

创建账户(CreateAccount)

API请求

URLs

POST zstack/v1/accounts

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "name": "test",     "password": "password",     "state": "Enabled"   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"test","password":"password","state":"Enabled"}}' \ http://localhost:8080/zstack/v1/accounts

参数列表

名字	类型	位置	描述	可选值	起始版本
name	String	body(包含在`params`结构中)	资源名称		0.6
password	String	body(包含在`params`结构中)	密码		0.6
type (可选)	String	body(包含在`params`结构中)	账户类型	SystemAdmin Normal	0.6
description (可选)	String	body(包含在`params`结构中)	资源的详细描述		0.6
resourceUuid (可选)	String	body(包含在`params`结构中)	资源UUID		0.6
systemTags (可选)	List	body	系统标签		0.6
userTags (可选)	List	body	用户标签		0.6
tagUuids (可选)	List	body(包含在`params`结构中)	标签UUID列表		4.3.0
state (可选)	String	body(包含在`params`结构中)	账户状态	Enabled Disabled Staled	4.3.0

API返回

返回示例

{   "inventory": {     "uuid": "77dc15220f71377ea48fa520d40d9169",     "name": "test",     "type": "Normal"   } }

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

#error

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

#inventory

名字	类型	描述	起始版本
uuid	String	账户的UUID，唯一标示该资源	4.0.0
name	String	账户名称	4.0.0
description	String	账户的详细描述	4.0.0
type	String	账户类型	4.0.0
state	String	账户状态	4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0

SDK示例

Java SDK

CreateAccountAction action = new CreateAccountAction(); action.name = "test"; action.password = "password"; action.state = "Enabled"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateAccountAction.Result res = action.call();

Python SDK

CreateAccountAction action = CreateAccountAction() action.name = "test" action.password = "password" action.state = "Enabled" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateAccountAction.Result res = action.call()

删除账户(DeleteAccount)

API请求

URLs

DELETE zstack/v1/accounts/{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/accounts/0f4d2956d5ef35fc9c51ca45b09ba2bb

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	0.6
deleteMode (可选)	String	body	删除模式	0.6
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.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

DeleteAccountAction action = new DeleteAccountAction(); action.uuid = "0f4d2956d5ef35fc9c51ca45b09ba2bb"; action.deleteMode = "Permissive"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; DeleteAccountAction.Result res = action.call();

Python SDK

DeleteAccountAction action = DeleteAccountAction() action.uuid = "0f4d2956d5ef35fc9c51ca45b09ba2bb" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" DeleteAccountAction.Result res = action.call()

更新账户(UpdateAccount)

API请求

URLs

PUT zstack/v1/accounts/{uuid}

Headers

Authorization: OAuth the-session-uuid

Body

{   "updateAccount": {     "password": "updatepassword",     "name": "updatename"   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X PUT -d '{"updateAccount":{"password":"updatepassword","name":"updatename"}}' \ http://localhost:8080/zstack/v1/accounts/99fcb2ad540c36f09e87c820ac6cb4cb

参数列表

名字	类型	位置	描述	可选值	起始版本
uuid	String	url	资源的UUID，唯一标示该资源		0.6
password (可选)	String	body(包含在updateAccount结构中)	密码		0.6
name (可选)	String	body(包含在updateAccount结构中)	账户名称		0.6
description (可选)	String	body(包含在updateAccount结构中)	资源的详细描述		0.6
systemTags (可选)	List	body	系统标签		0.6
userTags (可选)	List	body	用户标签		0.6
oldPassword (可选)	String	body(包含在updateAccount结构中)			3.6.0
state (可选)	String	body(包含在updateAccount结构中)	账户状态	Enabled Disabled Staled	4.3.0

API返回

返回示例

{   "inventory": {     "uuid": "ffbf2fac53b83b838d4551edcaff1d39",     "name": "test",     "type": "Normal"   } }

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

#error

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

#inventory

名字	类型	描述	起始版本
uuid	String	账户的UUID，唯一标示该资源	4.0.0
name	String	账户名称	4.0.0
description	String	账户的详细描述	4.0.0
type	state	账户类型	4.0.0
state	state	账户状态	4.0.0
createDate	Timestamp	创建时间	4.0.0
lastOpDate	Timestamp	最后一次修改时间	4.0.0

SDK示例

Java SDK

UpdateAccountAction action = new UpdateAccountAction(); action.uuid = "99fcb2ad540c36f09e87c820ac6cb4cb"; action.password = "updatepassword"; action.name = "updatename"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; UpdateAccountAction.Result res = action.call();

Python SDK

UpdateAccountAction action = UpdateAccountAction() action.uuid = "99fcb2ad540c36f09e87c820ac6cb4cb" action.password = "updatepassword" action.name = "updatename" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" UpdateAccountAction.Result res = action.call()