ZStack Cloud 4.4.0>开发手册>企业管理(Plus)>组织架构相关接口

组织架构相关接口

添加组织(CreateIAM2Organization)

API请求

URLs

POST /v1/iam2/organizations

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "org1",
    "type": "Company",
    "parentUuid": "b24b468d502f4d7e949dfcdf9036879c",
    "attributes": [
      {
        "name": "some-attribute-name",
        "value": "attribute-value"
      }
    ]
  },
  "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":"1c26fe0d3e384ac9bf67ce4340d65413","attributes":[{"name":"some-attribute-name","value":"attribute-value"}]}}' 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
systemTags (可选)	List	body			2.4.0
userTags (可选)	List	body			2.4.0

API返回

返回示例

{
  "inventory": {
    "uuid": "c623821bf32a4a9ea6e8e6839de79473",
    "name": "org1",
    "state": "Enabled",
    "type": "Company",
    "parentUuid": "58b7f5a391b64d189ba79217758cd30e",
    "attributes": [
      {
        "uuid": "b058dd2b053540faa97eb80e13b41970",
        "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)

API请求

URLs

DELETE /v1/iam2/organizations/{uuid}?deleteMode={deleteMode}

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/iam2/organizations/b30d1f09a0df3f708bba1208ade2aa90?deleteMode=Permissive

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	2.4.0
deleteMode (可选)	String	url		2.4.0
systemTags (可选)	List	body		2.4.0
userTags (可选)	List	body		2.4.0

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

DeleteIAM2OrganizationAction action = new DeleteIAM2OrganizationAction();
action.uuid = "b30d1f09a0df3f708bba1208ade2aa90";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteIAM2OrganizationAction.Result res = action.call();

Python SDK

DeleteIAM2OrganizationAction action = DeleteIAM2OrganizationAction()
action.uuid = "b30d1f09a0df3f708bba1208ade2aa90"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteIAM2OrganizationAction.Result res = action.call()

查询组织(QueryIAM2Organization)

API请求

URLs

GET zstack/v1/iam2/organizations

GET zstack/v1/iam2/organizations/{uuid}

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/iam2/organizations?q=name=test

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/iam2/organizations/e09768162e273e56aaffa649184585e3

可查询字段

运行zstack-cli命令行工具，输入QueryIAM2Organization并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "22e5c247ec02478286a1fccfdaa9a2d3",
      "name": "org1",
      "state": "Enabled",
      "type": "Company",
      "parentUuid": "3714d14d9b78487e983236a5ae65a190",
      "attributes": [
        {
          "uuid": "ee3bccfce21243cfbfc03cce1118b929",
          "name": "attribute-name",
          "value": "attribute-value",
          "type": "Customized"
        }
      ]
    }
  ]
}

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	2.4.0
inventories	List	详情参考inventories	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

#inventories

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

QueryIAM2OrganizationAction action = new QueryIAM2OrganizationAction();
action.conditions = asList("name=test");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryIAM2OrganizationAction.Result res = action.call();

Python SDK

QueryIAM2OrganizationAction action = QueryIAM2OrganizationAction()
action.conditions = ["name=test"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryIAM2OrganizationAction.Result res = action.call()

下一章:添加组织(CreateIAM2Organization)

学习路径

ZStack Cloud 产品学习路径

了解ZStack Cloud

ZStack Cloud 技术白皮书

ZStack Cloud 用户手册

新手快速入门

ZStack Cloud 快速安装使用教程（新手快速入门）

ZStack Cloud 升级教程

基础实践

ZStack Cloud CentOS7系统模板封装教程 ZStack Cloud Windows Server 2008 R2... ZStack Cloud CLI命令使用手册（基础命令） ZStack Cloud 存储部署教程 Shared Block-FC ZStack Cloud 存储部署教程 Shared Block-iSCSI ZStack Cloud 扁平网络使用教程

ZStack Cloud 专有网络VPC使用教程 ZStack Cloud 监控监控报警使用教程 ZStack Cloud 账户管理教程 ZStack Cloud 计费功能使用教程 ZStack Cloud 云主机高可用实践教程 ZStack Cloud 磁盘快照使用教程

进阶实验

ZStack Cloud 运维手册 ZStack Cloud CTL命令使用手册（高级命令） ZStack Cloud 多管理节点物理高可用教程 ZStack Cloud 企业管理使用教程 ZStack Cloud 网络QoS/磁盘QoS 使用教程 ZStack Cloud 亲和组使用教程 ZStack Cloud 弹性伸缩使用教程 ZStack Cloud vCenter环境管理指南

ZStack Cloud 迁移服务使用教程 ZStack Cloud 混合云使用教程 ZStack Cloud 灾备服务使用教程 ZStack Cloud 裸金属管理使用教程 ZStack Cloud 弹性裸金属管理使用教程 ZStack Cloud GPU设备透传使用教程 ZStack Cloud vGPU虚拟化使用教程 ZStack Cloud 资源编排使用教程

开发者资源

ZStack Cloud 开发手册

ZStack Cloud-CLI命令使用手册

常见问题

ZStack Cloud 产品学习路径

快速梳理文档，点击相应文本链接，快速跳转到相应文档的页面，学习 ZStack Cloud 产品。

我知道了

升级提醒

若您选择升级至4.0.0及之后版本，请注意以下功能调整：

1. 云路由器全面升级为VPC路由器，云路由网络全面升级为VPC网络，不再单独设云路由器页面。升级全程无感知，相关业务不受任何影响。

2. 企业管理账号体系取代用户组与用户，不再单独设用户/用户组页面，不可再使用用户/用户组账号登录云平台。升级前，请先将“用户组与用户”纳管的账号数据妥善迁移至“企业管理”纳管，再执行升级操作。注意：对于admin创建并具备admin权限的用户账号同步取消，如有需要，可使用企业管理账号体系中的平台管理员实现相同功能。

3. 调整AD/LDAP与账户的对接管理方式，统一由企业管理纳管，不再单独设AD/LDAP页面。升级前，请先将“账户”对接纳管的AD/LDAP账号数据妥善迁移至“企业管理”纳管，再执行升级操作。

如对上述升级提醒有任何疑问或需要升级帮助，请联系ZStack官方技术支持

下载ZStack企业版

您已填写过基本信息？点击这里

姓名姓名应该不少于两个字符

手机号手机号格式错误

验证码验证码填写错误获取短信验证码 60 秒后可重发

公司公司名称不应该少于4个字符

邮箱邮箱格式错误

下载链接将会通过邮件形式发送至您的邮箱，请谨慎填写。

下载ZStack企业版

还未填写过基本信息？点击这里

邮件或手机号码邮箱或手机号码格式错误账号不存在，请重新填写后提交

验证手机号

手机号手机号格式错误

验证码验证码填写错误获取短信验证码 60 秒后可重发

登录观看培训视频

仅对注册用户开放，请登录或填写资料观看培训视频

填写资料

商务咨询：

400-962-2212 转 1

售后咨询：

400-962-2212 转 2

商务联系：

sales@zstack.io

ZStack认证培训咨询

姓名姓名应该不少于两个字符

手机号手机号格式错误

验证码验证码填写错误获取短信验证码 60 秒后可重发

公司公司名称不应该少于4个字符

邮箱邮箱格式错误

商务咨询：

400-962-2212 转 1

商务联系：

channel@zstack.io

申请ZStack多机版

姓名姓名应该不少于两个字符

手机号手机号格式错误

验证码验证码填写错误获取短信验证码 60 秒后可重发

公司公司名称不应该少于4个字符

邮箱邮箱格式错误

商务咨询：

400-962-2212 转 1

售后咨询：

400-962-2212 转 2

商务联系：

sales@zstack.io

培训认证合作伙伴申请

姓名姓名应该不少于2个字符

手机号手机号格式错误

验证码验证码填写错误获取短信验证码 60 秒后可重发

邮箱邮箱格式错误

城市城市名称不应该少于2个字符

公司公司名称不应该少于4个字符

职位职位名称不应该少于2个字符

商务咨询：

400-962-2212 转 1

商务联系：

channel@zstack.io

ZStack&工信人才联合证书申请

已获得ZStack原厂证书

未获得ZStack原厂证书

请填写您的基本信息

姓名姓名应该不少于2个字符

手机号手机号格式错误

验证码验证码填写错误获取短信验证码 60 秒后可重发

邮箱邮箱格式错误

城市城市名称不应该少于2个字符

公司/学校

在校学生请填写学校名称

公司/学校名称不应该少于4个字符

证书类型

ZCCT

ZCCE

ZCCA

ZCPC-ISP

申请ZStack&工信人才联合证书须支付工本费，是否可以接受

商务咨询：

400-962-2212 转 1

商务联系：

channel@zstack.io

下载链接已发送至您的邮箱。

如未收到，请查看您的垃圾邮件、订阅邮件、广告邮件。当您收到电子邮件后，请点击 URL 链接，以完成下载。

下载链接已发送至您的邮箱。

如未收到，请查看您的垃圾邮件、订阅邮件、广告邮件。

或点击下方URL链接 (IE内核浏览器请右键另存为), 完成下载：

感谢您使用 ZStack 产品和服务。

成功提交申请。

我们将安排工作人员尽快与您取得联系。

感谢您使用 ZStack 产品和服务。

立即体验

联系我们

商务咨询

400-962-2212 转 1

售后咨询

400-962-2212 转 2

回到顶部

产品试用申请

请选择您要试用的产品

ZStack Cloud 企业版

ZStack Ceph分布式存储

ZStack Cloud 混合云版

ZStack Cube 超融合一体机

ZStack Cloud 基础版

ZStack Mini 边缘计算一体机

ZStack Cloud 标准版

ZStack CMP 多云管理平台

ZStack 信创云平台

ZStack Zaku 容器云平台

请填写您的基本信息

姓名姓名应该不少于两个字符

手机号手机号格式错误

验证码验证码填写错误获取短信验证码 60 秒后可重发

公司公司名称不应该少于4个字符

邮箱邮箱格式错误

商务咨询：

400-962-2212 转 1

售后咨询：

400-962-2212 转 2

商务联系：

sales@zstack.io

成功提交申请。

我们将安排工作人员尽快与您取得联系。

感谢您使用 ZStack 产品和服务。

组织架构相关接口