获取账户组下所有账户和组

API 请求

URLs

GET zstack/v1/account-groups/tree

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/account-groups/tree?groupUuid=470ce4d7a8dc32f597aa77675da3cd08&level=0&showGroup=true&showAccount=true

参数列表

名字	类型	位置	描述	起始版本
groupUuid (可选)	String	query	账户组 UUID; null 表示查询所有最上层账户组	4.10.0
level (可选)	int	query	向下查询子账户组的深度; 默认为 0 表示不查询子账户下的账户和组; 1 表示查询子账户下的账户和组	4.10.0
showGroup (可选)	boolean	query	返回结果是否包含账户组信息, 默认为 true 表示返回结果包含账户组信息	4.10.0
showAccount (可选)	boolean	query	返回结果是否包含账户信息, 默认为 true 表示返回结果包含账户信息	4.10.0
systemTags (可选)	List	query	系统标签	4.10.0
userTags (可选)	List	query	用户标签	4.10.0

API返回

返回示例

{
  "inventory": {
    "groupUuid": "5fdbee64b1944837a7a09f12fed57fec",
    "groupName": "my-group",
    "inventory": {
      "uuid": "5fdbee64b1944837a7a09f12fed57fec",
      "name": "my-group",
      "description": "my-group-description",
      "rootGroupUuid": "5fdbee64b1944837a7a09f12fed57fec",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    },
    "accounts": [
      {
        "uuid": "6a31cfb1bdf8422aa78b38bc6f65a199",
        "name": "account1",
        "description": "account1-description",
        "type": "Normal",
        "state": "Enabled",
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    ],
    "groups": [
      {
        "groupUuid": "cc6ed770ad4c4ec3a229ca8fd2d4e223",
        "groupName": "child-group",
        "accounts": [],
        "groups": []
      }
    ]
  }
}

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

inventories

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

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

SDK示例

Java SDK

GetAccountGroupTreeAction action = new GetAccountGroupTreeAction();
action.groupUuid = "470ce4d7a8dc32f597aa77675da3cd08";
action.level = 0;
action.showGroup = true;
action.showAccount = true;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetAccountGroupTreeAction.Result res = action.call();

Python SDK

GetAccountGroupTreeAction action = GetAccountGroupTreeAction()
action.groupUuid = "470ce4d7a8dc32f597aa77675da3cd08"
action.level = 0
action.showGroup = true
action.showAccount = true
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetAccountGroupTreeAction.Result res = action.call()