ZStack Cloud 5.3.40>ZStack CLoud开发手册>运营管理>租户管理(Plus)

运营管理

租户管理(Plus)

租户管理以单独的功能模块形式提供，需提前购买租户管理模块许可证，且需在购买云平台许可证基础上使用，不可单独使用。

组织架构相关接口

添加组织(CreateIAM2Organization)

API请求

URLs

POST /v1/iam2/organizations

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "name": "org1",     "type": "Company",     "parentUuid": "398f147aef0347099c16548bce0ceca1",     "attributes": [       {         "name": "some-attribute-name",         "value": "attribute-value"       }     ],     "quota": {       "vm.num": 100.0     }   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"org1","type":"Company","parentUuid":"939e7abba5ec42b084d0be9945b95fc2","attributes":[{"name":"some-attribute-name","value":"attribute-value"}],"quota":{"vm.num":100.0}}}' http://localhost:8080/zstack/v1/iam2/organizations

参数列表

名字	类型	位置	描述	可选值	起始版本
name	String	body(包含在params结构中)	资源名称		2.4.0
description (可选)	String	body(包含在params结构中)	资源的详细描述		2.4.0
type	OrganizationType	body(包含在params结构中)	组织类型	Company Department	2.4.0
parentUuid (可选)	String	body(包含在params结构中)			2.4.0
attributes (可选)	List	body(包含在params结构中)			2.4.0
resourceUuid (可选)	String	body(包含在params结构中)			2.4.0
quota (可选)	List	body(包含在params结构中)	配额		4.3.6
systemTags (可选)	List	body			2.4.0
userTags (可选)	List	body			2.4.0

API返回

返回示例

{   "inventory": {     "uuid": "d8880014345347e1ab945d8ef750fac7",     "name": "org1",     "state": "Enabled",     "type": "Company",     "srcType": "ZStack",     "parentUuid": "1dffd2c40215412d8ab4b811ce6888f0",     "rootOrganizationUuid": "a531128bc8724f0ba55a85c425f22c32",     "attributes": [       {         "uuid": "053353cf77d6493daef4de70c9ff8d24",         "name": "attribute-name",         "value": "attribute-value",         "type": "Customized"       }     ]   } }

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

#error

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

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	2.4.0
name	String	资源名称	2.4.0
description	String	资源的详细描述	2.4.0
createDate	Timestamp	创建时间	2.4.0
lastOpDate	Timestamp	最后一次修改时间	2.4.0
parentUuid	String		2.4.0
state	State	详情参考state	2.4.0
type	OrganizationType	详情参考type	2.4.0
attributes	List	详情参考attributes	2.4.0

#state

名字	类型	描述	起始版本
name	String	资源名称	2.4.0
ordinal	int		2.4.0

#type

名字	类型	描述	起始版本
name	String	资源名称	2.4.0
ordinal	int		2.4.0

#attributes

名字	类型	描述	起始版本
organizationUuid	String		2.4.0
uuid	String	资源的UUID，唯一标示该资源	2.4.0
name	String	资源名称	2.4.0
value	String		2.4.0
type	AttributeType	详情参考type	2.4.0

#type

名字	类型	描述	起始版本
name	String	资源名称	2.4.0
ordinal	int		2.4.0

SDK示例

Java SDK

CreateIAM2OrganizationAction action = new CreateIAM2OrganizationAction(); action.name = "org1"; action.type = "Company"; action.parentUuid = "1d650e96108c47a297a7529d45afef97"; action.attributes = asList([name:some-attribute-name, value:attribute-value]); action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateIAM2OrganizationAction.Result res = action.call();

Python SDK

CreateIAM2OrganizationAction action = CreateIAM2OrganizationAction() action.name = "org1" action.type = "Company" action.parentUuid = "a7faaafa84ae4345957fd7e61434481b" action.attributes = [[name:some-attribute-name, value:attribute-value]] action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateIAM2OrganizationAction.Result res = action.call()

删除组织(DeleteIAM2Organization)