文档目录

组织架构相关接口

添加组织(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": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示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)

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

可查询字段

运行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()

更新组织(UpdateIAM2Organization)

API请求

URLs
PUT zstack/v1/iam2/organizations/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateIAM2Organization": {
    "name": "new-name",
    "description": "new-description",
    "parentUuid": "56bf430cab663c908d1ebe7ab28e5e90"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateIAM2Organization":{"name":"new-name","description":"new-description","parentUuid":"56bf430cab663c908d1ebe7ab28e5e90"}}' http://localhost:8080/zstack/v1/iam2/organizations/f68813583328377fa44bb72d75a13ed5/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 2.4.0
name (可选) String body(包含在updateIAM2Organization结构中) 资源名称 2.4.0
description (可选) String body(包含在updateIAM2Organization结构中) 资源的详细描述 2.4.0
parentUuid (可选) String body(包含在updateIAM2Organization结构中) 2.4.0
type (可选) OrganizationType body(包含在updateIAM2Organization结构中)
  • Company
  • Department
2.4.0
systemTags (可选) List body 2.4.0
userTags (可选) List body 2.4.0

API返回

返回示例
{
  "inventory": {
    "uuid": "3f0315c83d524c0fa0da9be22c1cd58e",
    "name": "org1",
    "state": "Enabled",
    "type": "Company",
    "parentUuid": "8b15e39fb62a43089610103be30c17b5",
    "attributes": [
      {
        "uuid": "5dd14ca022554b22938d94c27de872fb",
        "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
UpdateIAM2OrganizationAction action = new UpdateIAM2OrganizationAction();
action.uuid = "f68813583328377fa44bb72d75a13ed5";
action.name = "new-name";
action.description = "new-description";
action.parentUuid = "56bf430cab663c908d1ebe7ab28e5e90";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateIAM2OrganizationAction.Result res = action.call();
Python SDK
UpdateIAM2OrganizationAction action = UpdateIAM2OrganizationAction()
action.uuid = "f68813583328377fa44bb72d75a13ed5"
action.name = "new-name"
action.description = "new-description"
action.parentUuid = "56bf430cab663c908d1ebe7ab28e5e90"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateIAM2OrganizationAction.Result res = action.call()

修改组织的上级部门(ChangeIAM2OrganizationParent)

API请求

URLs
PUT zstack/v1/iam2/organizations/{parentUuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "changeIAM2OrganizationParent": {
    "childrenUuids": [
      "b71dcc43656f399c82b09a379d1d6a74",
      "220c9c0ec8a53c37b9c680b0deed7563"
    ]
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeIAM2OrganizationParent":{"childrenUuids":["b71dcc43656f399c82b09a379d1d6a74","220c9c0ec8a53c37b9c680b0deed7563"]}}' http://localhost:8080/zstack/v1/iam2/organizations/4fef501c5ba331f496907f642f609ea3/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
parentUuid String url 2.4.0
childrenUuids List body(包含在changeIAM2OrganizationParent结构中) 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
ChangeIAM2OrganizationParentAction action = new ChangeIAM2OrganizationParentAction();
action.parentUuid = "4fef501c5ba331f496907f642f609ea3";
action.childrenUuids = asList("b71dcc43656f399c82b09a379d1d6a74","220c9c0ec8a53c37b9c680b0deed7563");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeIAM2OrganizationParentAction.Result res = action.call();
Python SDK
ChangeIAM2OrganizationParentAction action = ChangeIAM2OrganizationParentAction()
action.parentUuid = "4fef501c5ba331f496907f642f609ea3"
action.childrenUuids = [b71dcc43656f399c82b09a379d1d6a74, 220c9c0ec8a53c37b9c680b0deed7563]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeIAM2OrganizationParentAction.Result res = action.call()

修改组织状态(ChangeIAM2OrganizationState)

API请求

URLs
PUT zstack/v1/iam2/organizations/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "changeIAM2OrganizationState": {
    "stateEvent": "enable"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeIAM2OrganizationState":{"stateEvent":"enable"}}' http://localhost:8080/zstack/v1/iam2/organizations/61e292aa7d3f3796a313c338214e0f34/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 2.4.0
stateEvent StateEvent body(包含在changeIAM2OrganizationState结构中)
  • enable
  • disable
2.4.0
systemTags (可选) List body 2.4.0
userTags (可选) List body 2.4.0

API返回

返回示例
{
  "inventory": {
    "uuid": "c62fea9f96644a9cb5ba1ba383a9335c",
    "name": "org1",
    "state": "Enabled",
    "type": "Company",
    "parentUuid": "80f101e520f94f958b1357f7d7a3dc37",
    "attributes": [
      {
        "uuid": "754a49f70fcb46ad879b347447af7b25",
        "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
ChangeIAM2OrganizationStateAction action = new ChangeIAM2OrganizationStateAction();
action.uuid = "61e292aa7d3f3796a313c338214e0f34";
action.stateEvent = "enable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeIAM2OrganizationStateAction.Result res = action.call();
Python SDK
ChangeIAM2OrganizationStateAction action = ChangeIAM2OrganizationStateAction()
action.uuid = "61e292aa7d3f3796a313c338214e0f34"
action.stateEvent = "enable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeIAM2OrganizationStateAction.Result res = action.call()

从组织移除属性(RemoveAttributesFromIAM2Organization)

API请求

URLs
DELETE zstack/v1/iam2/organizations/{uuid}/attributes?attributeUuids={attributeUuids}
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/7783a8869e6a31a29562fb58dfdccc69/attributes?attributeUuids=cdec45ca22a43b47942268b3dc90bc43&attributeUuids=f6febd00a2633bd98d8763ffdff1b693
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 2.4.0
attributeUuids List 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
RemoveAttributesFromIAM2OrganizationAction action = new RemoveAttributesFromIAM2OrganizationAction();
action.uuid = "7783a8869e6a31a29562fb58dfdccc69";
action.attributeUuids = asList("cdec45ca22a43b47942268b3dc90bc43","f6febd00a2633bd98d8763ffdff1b693");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RemoveAttributesFromIAM2OrganizationAction.Result res = action.call();
Python SDK
RemoveAttributesFromIAM2OrganizationAction action = RemoveAttributesFromIAM2OrganizationAction()
action.uuid = "7783a8869e6a31a29562fb58dfdccc69"
action.attributeUuids = [cdec45ca22a43b47942268b3dc90bc43, f6febd00a2633bd98d8763ffdff1b693]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveAttributesFromIAM2OrganizationAction.Result res = action.call()

从组织移除用户(RemoveIAM2VirtualIDsFromOrganization)

API请求

URLs
DELETE zstack/v1/iam2/organizations/{organizationUuid}/virtual-ids?virtualIDUuids={virtualIDUuids}
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/a28a5646a6ed32b2b854af830709d05c/virtual-ids?virtualIDUuids=f998d391462734c69998072fc801b96c&virtualIDUuids=df9c6eeb32df35558b8dd214f2527a23
参数列表
名字 类型 位置 描述 可选值 起始版本
virtualIDUuids List url 2.4.0
organizationUuid 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
RemoveIAM2VirtualIDsFromOrganizationAction action = new RemoveIAM2VirtualIDsFromOrganizationAction();
action.virtualIDUuids = asList("f998d391462734c69998072fc801b96c","df9c6eeb32df35558b8dd214f2527a23");
action.organizationUuid = "a28a5646a6ed32b2b854af830709d05c";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RemoveIAM2VirtualIDsFromOrganizationAction.Result res = action.call();
Python SDK
RemoveIAM2VirtualIDsFromOrganizationAction action = RemoveIAM2VirtualIDsFromOrganizationAction()
action.virtualIDUuids = [f998d391462734c69998072fc801b96c, df9c6eeb32df35558b8dd214f2527a23]
action.organizationUuid = "a28a5646a6ed32b2b854af830709d05c"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveIAM2VirtualIDsFromOrganizationAction.Result res = action.call()

创建用户(CreateIAM2VirtualID)

API请求

URLs
POST zstack/v1/iam2/virtual-ids
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "name": "id1",
    "password": "password",
    "attributes": [
      {
        "name": "some-attribute-name",
        "value": "attribute-value"
      }
    ],
    "projectUuid": "fbc22f14b3873e30b4439d973ab2f817",
    "organizationUuid": "5fef6c4ca6e63c7fa5e82d1437190ebe",
    "withoutDefaultRole": false
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"id1","password":"password","attributes":[{"name":"some-attribute-name","value":"attribute-value"}],"projectUuid":"fbc22f14b3873e30b4439d973ab2f817","organizationUuid":"5fef6c4ca6e63c7fa5e82d1437190ebe","withoutDefaultRole":false}}' http://localhost:8080/zstack/v1/iam2/virtual-ids
参数列表
名字 类型 位置 描述 可选值 起始版本
name String body(包含在params结构中) 资源名称 2.4.0
password String body(包含在params结构中) 2.4.0
description (可选) String body(包含在params结构中) 资源的详细描述 2.4.0
attributes (可选) List body(包含在params结构中) 2.4.0
projectUuid (可选) String body(包含在params结构中) 2.4.0
organizationUuid (可选) String body(包含在params结构中) 2.4.0
resourceUuid (可选) String body(包含在params结构中) 2.4.0
tagUuids (可选) List body(包含在params结构中) 标签UUID列表 3.4.0
systemTags (可选) List body 2.4.0
userTags (可选) List body 2.4.0

API返回

返回示例
{
  "inventory": {
    "uuid": "894f1c5bf6714a76b08324c69b8cac7c",
    "name": "id1",
    "state": "Enabled",
    "attributes": [
      {
        "uuid": "04f039d7f3f04dc5a1b6bf9fe93e6cdd",
        "name": "attribute-name",
        "value": "attribute-value",
        "type": "Customized"
      }
    ]
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.4.0
inventory IAM2VirtualIDInventory 详情参考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
state State 详情参考state 2.4.0
attributes List 详情参考attributes 2.4.0
#state
名字 类型 描述 起始版本
name String 资源名称 2.4.0
ordinal int 2.4.0
#attributes
名字 类型 描述 起始版本
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
CreateIAM2VirtualIDAction action = new CreateIAM2VirtualIDAction();
action.name = "id1";
action.password = "password";
action.attributes = asList([name:some-attribute-name, value:attribute-value]);
action.projectUuid = "fbc22f14b3873e30b4439d973ab2f817";
action.organizationUuid = "5fef6c4ca6e63c7fa5e82d1437190ebe";
action.withoutDefaultRole = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateIAM2VirtualIDAction.Result res = action.call();
Python SDK
CreateIAM2VirtualIDAction action = CreateIAM2VirtualIDAction()
action.name = "id1"
action.password = "password"
action.attributes = [[name:some-attribute-name, value:attribute-value]]
action.projectUuid = "fbc22f14b3873e30b4439d973ab2f817"
action.organizationUuid = "5fef6c4ca6e63c7fa5e82d1437190ebe"
action.withoutDefaultRole = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateIAM2VirtualIDAction.Result res = action.call()

删除用户(DeleteIAM2VirtualID)

API请求

URLs
DELETE zstack/v1/iam2/virtual-ids/{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/virtual-ids/b141cd136a1f384d9e8e68319f8e1281?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
DeleteIAM2VirtualIDAction action = new DeleteIAM2VirtualIDAction();
action.uuid = "b141cd136a1f384d9e8e68319f8e1281";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteIAM2VirtualIDAction.Result res = action.call();
Python SDK
DeleteIAM2VirtualIDAction action = DeleteIAM2VirtualIDAction()
action.uuid = "b141cd136a1f384d9e8e68319f8e1281"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteIAM2VirtualIDAction.Result res = action.call()

查询用户(QueryIAM2VirtualID)

API请求

URLs
GET zstack/v1/iam2/virtual-ids
GET zstack/v1/iam2/virtual-ids/{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/virtual-ids?q=name=test
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/iam2/virtual-ids/53c8b09e9ea63679add5c2003c4ce1cd

可查询字段

运行CLI命令行工具,输入QueryIAM2VirtualID并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例
{
  "inventories": [
    {
      "uuid": "e6e349e2d3e94ad39d2d620366de2b33",
      "name": "id1",
      "state": "Enabled",
      "attributes": [
        {
          "uuid": "fcd5e53a4bc44906a31e93012b46dab1",
          "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
state State 详情参考state 2.4.0
attributes List 详情参考attributes 2.4.0
#state
名字 类型 描述 起始版本
name String 资源名称 2.4.0
ordinal int 2.4.0
#attributes
名字 类型 描述 起始版本
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
QueryIAM2VirtualIDAction action = new QueryIAM2VirtualIDAction();
action.conditions = asList("name=test");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryIAM2VirtualIDAction.Result res = action.call();
Python SDK
QueryIAM2VirtualIDAction action = QueryIAM2VirtualIDAction()
action.conditions = ["name=test"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryIAM2VirtualIDAction.Result res = action.call()

登录用户(LoginIAM2VirtualID)

API请求

URLs
PUT zstack/v1/iam2/virtual-ids/login
Body
{
  "loginIAM2VirtualID": {
    "name": "id1",
    "password": "password"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-X PUT -d '{"loginIAM2VirtualID":{"name":"id1","password":"password"}}' http://localhost:8080/zstack/v1/iam2/virtual-ids/login
参数列表
名字 类型 位置 描述 可选值 起始版本
name String body(包含在loginIAM2VirtualID结构中) 资源名称 2.4.0
password String body(包含在loginIAM2VirtualID结构中) 2.4.0
systemTags (可选) List body 2.4.0
userTags (可选) List body 2.4.0
captchaUuid (可选) String body(包含在loginIAM2VirtualID结构中) 2.4.0
verifyCode (可选) String body(包含在loginIAM2VirtualID结构中) 2.4.0
clientInfo (可选) Map body(包含在loginIAM2VirtualID结构中) 客户端信息 3.5.0
Note:
  • ZStack Cloud使用IAM2用户身份登录时支持双因子登录验证,SystemTags增加twofatoken选项。
    • 选项格式为:twofatoken::双因子验证6位安全码
    • 例如:twofatoken::123456

API返回

返回示例
{
  "inventory": {
    "uuid": "7fcdc9d9e4bf3d8681a4472f38951dc0",
    "noSessionEvaluation": false
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.4.0
inventory SessionInventory 详情参考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
accountUuid String 账户UUID 2.4.0
userUuid String 用户UUID 2.4.0
expiredDate Timestamp 2.4.0
createDate Timestamp 创建时间 2.4.0

SDK示例

Java SDK
LoginIAM2VirtualIDAction action = new LoginIAM2VirtualIDAction();
action.name = "id1";
action.password = "password";
LoginIAM2VirtualIDAction.Result res = action.call();
Python SDK
LoginIAM2VirtualIDAction action = LoginIAM2VirtualIDAction()
action.name = "id1"
action.password = "password"
LoginIAM2VirtualIDAction.Result res = action.call()

修改用户状态(ChangeIAM2VirtualIDState)

API请求

URLs
PUT zstack/v1/iam2/virtual-ids/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "changeIAM2VirtualIDState": {
    "stateEvent": "enable"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeIAM2VirtualIDState":{"stateEvent":"enable"}}' http://localhost:8080/zstack/v1/iam2/virtual-ids/cc723702dcc24fafba542aa64d953d58/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 2.4.0
stateEvent StateEvent body(包含在changeIAM2VirtualIDState结构中)
  • enable
  • disable
2.4.0
systemTags (可选) List body 2.4.0
userTags (可选) List body 2.4.0

API返回

返回示例
{
  "inventory": {
    "uuid": "0524ea53082646569dfbc1bdecc82b70",
    "name": "id1",
    "state": "Enabled",
    "attributes": [
      {
        "uuid": "9eb16e277f1f412890e0fa8f6b76d432",
        "name": "attribute-name",
        "value": "attribute-value",
        "type": "Customized"
      }
    ]
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.4.0
inventory IAM2VirtualIDInventory 详情参考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
state State 详情参考state 2.4.0
attributes List 详情参考attributes 2.4.0
#state
名字 类型 描述 起始版本
name String 资源名称 2.4.0
ordinal int 2.4.0
#attributes
名字 类型 描述 起始版本
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
ChangeIAM2VirtualIDStateAction action = new ChangeIAM2VirtualIDStateAction();
action.uuid = "028961c0f40b4a63b8bf8f8fb6da2e6a";
action.stateEvent = "enable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeIAM2VirtualIDStateAction.Result res = action.call();
Python SDK
ChangeIAM2VirtualIDStateAction action = ChangeIAM2VirtualIDStateAction()
action.uuid = "7a40071d17b74e8085fb41c1e6f2216b"
action.stateEvent = "enable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeIAM2VirtualIDStateAction.Result res = action.call()

将用户添加到组织(AddIAM2VirtualIDsToOrganization)

API请求

URLs
POST zstack/v1/iam2/organizations/{organizationUuid}/virtual-ids
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "virtualIDUuids": [
      "e747d2bd298c38aab5ac7ee561377845",
      "8bda3c55564031bc9666cd6607e1aa6f"
    ]
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"virtualIDUuids":["e747d2bd298c38aab5ac7ee561377845","8bda3c55564031bc9666cd6607e1aa6f"]}}' http://localhost:8080/zstack/v1/iam2/organizations/e28067165c7a3d098ea64c564ac2f53f/virtual-ids
参数列表
名字 类型 位置 描述 可选值 起始版本
virtualIDUuids List body(包含在params结构中) 2.4.0
organizationUuid 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
AddIAM2VirtualIDsToOrganizationAction action = new AddIAM2VirtualIDsToOrganizationAction();
action.virtualIDUuids = asList("e747d2bd298c38aab5ac7ee561377845","8bda3c55564031bc9666cd6607e1aa6f");
action.organizationUuid = "e28067165c7a3d098ea64c564ac2f53f";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddIAM2VirtualIDsToOrganizationAction.Result res = action.call();
Python SDK
AddIAM2VirtualIDsToOrganizationAction action = AddIAM2VirtualIDsToOrganizationAction()
action.virtualIDUuids = [e747d2bd298c38aab5ac7ee561377845, 8bda3c55564031bc9666cd6607e1aa6f]
action.organizationUuid = "e28067165c7a3d098ea64c564ac2f53f"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddIAM2VirtualIDsToOrganizationAction.Result res = action.call()

为用户添加属性(AddAttributesToIAM2VirtualID)

API请求

URLs
POST zstack/v1/iam2/virtual-ids/{uuid}/attributes
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "attributes": [
      {
        "name": "some-attribute-name",
        "value": "attribute-value"
      }
    ]
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 2.4.0
attributes List body(包含在params结构中) 属性 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
AddAttributesToIAM2VirtualIDAction action = new AddAttributesToIAM2VirtualIDAction();
action.uuid = "94d943b468573d9d9cdfd5472a6235dc";
action.attributes = asList([name:some-attribute-name, value:attribute-value]);
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddAttributesToIAM2VirtualIDAction.Result res = action.call();
Python SDK
AddAttributesToIAM2VirtualIDAction action = AddAttributesToIAM2VirtualIDAction()
action.uuid = "94d943b468573d9d9cdfd5472a6235dc"
action.attributes = [[name:some-attribute-name, value:attribute-value]]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddAttributesToIAM2VirtualIDAction.Result res = action.call()

从用户移除属性(RemoveAttributesFromIAM2VirtualID)

API请求

URLs
DELETE zstack/v1/iam2/virtual-ids/{uuid}/attributes?attributeUuids={attributeUuids}
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/virtual-ids/041a44d7d5983fe480c577c897b08eb7/attributes?attributeUuids=4d06d2b6742636dfaed60ea4b8807aa2&attributeUuids=c7ba41447321334b852cf2217bfa34f4
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 2.4.0
attributeUuids List 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
RemoveAttributesFromIAM2VirtualIDAction action = new RemoveAttributesFromIAM2VirtualIDAction();
action.uuid = "041a44d7d5983fe480c577c897b08eb7";
action.attributeUuids = asList("4d06d2b6742636dfaed60ea4b8807aa2","c7ba41447321334b852cf2217bfa34f4");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RemoveAttributesFromIAM2VirtualIDAction.Result res = action.call();
Python SDK
RemoveAttributesFromIAM2VirtualIDAction action = RemoveAttributesFromIAM2VirtualIDAction()
action.uuid = "041a44d7d5983fe480c577c897b08eb7"
action.attributeUuids = [4d06d2b6742636dfaed60ea4b8807aa2, c7ba41447321334b852cf2217bfa34f4]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveAttributesFromIAM2VirtualIDAction.Result res = action.call()

设置部门负责人(SetOrganizationSupervisor)

API请求

URLs
PUT zstack/v1/iam2/organizations/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "setOrganizationSupervisor": {
    "virtualIDUuid": "b3edb976bc0244b38711fad11913fb49"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"setOrganizationSupervisor":{"virtualIDUuid":"4424b77e00cb49bca232faf58e5d1f5e"}}' http://localhost:8080/zstack/v1/iam2/organizations/25a96af2ef0144e5ae4d0fbee57a6af8/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 3.6.0
virtualIDUuid String body(包含在setOrganizationSupervisor结构中) 3.6.0
systemTags (可选) List body 3.6.0
userTags (可选) List body 3.6.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
SetOrganizationSupervisorAction action = new SetOrganizationSupervisorAction();
action.uuid = "ea1a78daf9ff449b89326e95bc56bdcd";
action.virtualIDUuid = "b0d40be841ad41b7aec8a80ee483a88b";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SetOrganizationSupervisorAction.Result res = action.call();
Python SDK
SetOrganizationSupervisorAction action = SetOrganizationSupervisorAction()
action.uuid = "a4f5561ff9404c6ebb6c07dce8245f17"
action.virtualIDUuid = "d9376e7c92cf43f3a27bf006e46406ca"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SetOrganizationSupervisorAction.Result res = action.call()

通过文件导入方式创建用户(BatchCreateIAM2VirtualIDFromConfigFile)

根据导入文件批量创建IAM2用户。

API请求

URLs
POST zstack/v1/iam2/virtual-ids/from-file
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "virtualIDInfos": "FILE CONTENT ENCODE BY BASE64"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"virtualIDInfos":"FILE CONTENT ENCODE BY BASE64"}}' http://localhost:8080/zstack/v1/iam2/virtual-ids/from-file
参数列表
名字 类型 位置 描述 可选值 起始版本
virtualIDInfos String body(包含在params结构中) 传入的base64格式的用户信息 3.6.0
resourceUuid (可选) String body(包含在params结构中) 3.6.0
tagUuids (可选) List body(包含在params结构中) 标签UUID列表 3.6.0
systemTags (可选) List body 3.6.0
userTags (可选) List body 3.6.0

API返回

返回示例
{
  "numberOfImportedUser": 10.0
}
名字 类型 描述 起始版本
numberOfImportedUser int 批量创建用户时成功创建的用户数量 3.6.0
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 3.6.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 3.6.0
description String 错误的概要描述 3.6.0
details String 错误的详细信息 3.6.0
elaboration String 保留字段,默认为null 3.6.0
opaque LinkedHashMap 保留字段,默认为null 3.6.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 3.6.0

SDK示例

Java SDK
BatchCreateIAM2VirtualIDFromConfigFileAction action = new BatchCreateIAM2VirtualIDFromConfigFileAction();
action.virtualIDInfos = "FILE CONTENT ENCODE BY BASE64";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
BatchCreateIAM2VirtualIDFromConfigFileAction.Result res = action.call();
Python SDK
BatchCreateIAM2VirtualIDFromConfigFileAction action = BatchCreateIAM2VirtualIDFromConfigFileAction()
action.virtualIDInfos = "FILE CONTENT ENCODE BY BASE64"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
BatchCreateIAM2VirtualIDFromConfigFileAction.Result res = action.call()

创建用户文件语法检查(CheckIAM2VirtualIDConfigFile)

检查文件传入的用户信息是否可用于批量创建。

API请求

URLs
PUT zstack/v1/iam2/virtual-ids/from-file
Headers
Authorization: OAuth the-session-uuid
Body
{
  "checkIAM2VirtualIDConfigFile": {
    "virtualIDInfos": "FILE CONTENT ENCODE BY BASE64"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"checkIAM2VirtualIDConfigFile":{"virtualIDInfos":"FILE CONTENT ENCODE BY BASE64"}}' http://localhost:8080/zstack/v1/iam2/virtual-ids/from-file
参数列表
名字 类型 位置 描述 可选值 起始版本
virtualIDInfos String body(包含在checkIAM2VirtualIDConfigFile结构中) 传入的base64格式的用户信息 3.6.0
systemTags (可选) List body 3.6.0
userTags (可选) List body 3.6.0

API返回

返回示例
{
  "results": [
    {
      "line": 123.0,
      "detail": "用户名重复"
    }
  ]
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 3.6.0
results List 详情参考results 3.6.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 3.6.0
description String 错误的概要描述 3.6.0
details String 错误的详细信息 3.6.0
elaboration String 保留字段,默认为null 3.6.0
opaque LinkedHashMap 保留字段,默认为null 3.6.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 3.6.0
#results
名字 类型 描述 起始版本
line int 3.6.0
detail String 3.6.0

SDK示例

Java SDK
CheckIAM2VirtualIDConfigFileAction action = new CheckIAM2VirtualIDConfigFileAction();
action.virtualIDInfos = "FILE CONTENT ENCODE BY BASE64";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CheckIAM2VirtualIDConfigFileAction.Result res = action.call();
Python SDK
CheckIAM2VirtualIDConfigFileAction action = CheckIAM2VirtualIDConfigFileAction()
action.virtualIDInfos = "FILE CONTENT ENCODE BY BASE64"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CheckIAM2VirtualIDConfigFileAction.Result res = action.call()

将项目加载到组织(AttachIAM2ProjectToIAM2Organization)

API请求

URLs
POST zstack/v1/iam2/projects/{projectUuid}/iam2/organizations/{organizationUuid}
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {},
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{}}' http://localhost:8080/zstack/v1/iam2/projects/d5698b56f9f23a61958201cf7bee4e72/iam2/organizations/72363068daea3772bb52aa663554c1e5
参数列表
名字 类型 位置 描述 可选值 起始版本
projectUuid String url 项目UUID 3.6.0
organizationUuid String url 组织UUID 3.6.0
systemTags (可选) List body 3.6.0
userTags (可选) List body 3.6.0

API返回

返回示例
{
  "inventory": {
    "uuid": "262a60f99c5a49e8866ed9f92ef550e2",
    "name": "project",
    "state": "Enabled"
  }
}
名字 类型 描述 起始版本
success boolean 4.7.0
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 3.6.0
inventory IAM2ProjectInventory 详情参考inventory 3.6.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 3.6.0
description String 错误的概要描述 3.6.0
details String 错误的详细信息 3.6.0
elaboration String 保留字段,默认为null 3.6.0
opaque LinkedHashMap 保留字段,默认为null 3.6.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 3.6.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 3.6.0
name String 资源名称 3.6.0
description String 资源的详细描述 3.6.0
createDate Timestamp 创建时间 3.6.0
lastOpDate Timestamp 最后一次修改时间 3.6.0
linkedAccountUuid String 3.6.0
state ProjectState 详情参考state 3.6.0
attributes List 详情参考attributes 3.6.0
#state
名字 类型 描述 起始版本
name String 资源名称 3.6.0
ordinal int 3.6.0
#attributes
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 3.6.0
name String 资源名称 3.6.0
value String 3.6.0
type AttributeType 详情参考type 3.6.0
#type
名字 类型 描述 起始版本
name String 资源名称 3.6.0
ordinal int 3.6.0

SDK示例

Java SDK
AttachIAM2ProjectToIAM2OrganizationAction action = new AttachIAM2ProjectToIAM2OrganizationAction();
action.projectUuid = "d5698b56f9f23a61958201cf7bee4e72";
action.organizationUuid = "72363068daea3772bb52aa663554c1e5";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachIAM2ProjectToIAM2OrganizationAction.Result res = action.call();
Python SDK
AttachIAM2ProjectToIAM2OrganizationAction action = AttachIAM2ProjectToIAM2OrganizationAction()
action.projectUuid = "d5698b56f9f23a61958201cf7bee4e72"
action.organizationUuid = "72363068daea3772bb52aa663554c1e5"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AttachIAM2ProjectToIAM2OrganizationAction.Result res = action.call()

从组织卸载项目(DetachIAM2ProjectFromIAM2Organization)

API请求

URLs
DELETE zstack/v1/iam2/projects/{projectUuid}/iam2/organizations
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/projects/3fbdf0b46d3b3dec908ddb90fd4c6f42/iam2/organizations
参数列表
名字 类型 位置 描述 可选值 起始版本
projectUuid String url 项目UUID 3.6.0
systemTags (可选) List body 3.6.0
userTags (可选) List body 3.6.0

API返回

返回示例
{
  "inventory": {
    "uuid": "de0637fdd1ca423489d31ab65e5bf886",
    "name": "project",
    "state": "Enabled"
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 3.6.0
inventory IAM2ProjectInventory 详情参考inventory 3.6.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 3.6.0
description String 错误的概要描述 3.6.0
details String 错误的详细信息 3.6.0
elaboration String 保留字段,默认为null 3.6.0
opaque LinkedHashMap 保留字段,默认为null 3.6.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 3.6.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 3.6.0
name String 资源名称 3.6.0
description String 资源的详细描述 3.6.0
createDate Timestamp 创建时间 3.6.0
lastOpDate Timestamp 最后一次修改时间 3.6.0
linkedAccountUuid String 3.6.0
state ProjectState 详情参考state 3.6.0
attributes List 详情参考attributes 3.6.0
#state
名字 类型 描述 起始版本
name String 资源名称 3.6.0
ordinal int 3.6.0
#attributes
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 3.6.0
name String 资源名称 3.6.0
value String 3.6.0
type AttributeType 详情参考type 3.6.0
#type
名字 类型 描述 起始版本
name String 资源名称 3.6.0
ordinal int 3.6.0

SDK示例

Java SDK
DetachIAM2ProjectFromIAM2OrganizationAction action = new DetachIAM2ProjectFromIAM2OrganizationAction();
action.projectUuid = "3fbdf0b46d3b3dec908ddb90fd4c6f42";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DetachIAM2ProjectFromIAM2OrganizationAction.Result res = action.call();
Python SDK
DetachIAM2ProjectFromIAM2OrganizationAction action = DetachIAM2ProjectFromIAM2OrganizationAction()
action.projectUuid = "3fbdf0b46d3b3dec908ddb90fd4c6f42"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DetachIAM2ProjectFromIAM2OrganizationAction.Result res = action.call()

查询组织与项目关联关系(QueryIAM2OrganizationProjectRef)

API请求

URLs
GET zstack/v1/iam2/projects/organizations/refs
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/projects/organizations/refs?q=projectUuid=6b0fa1d3c0433a378e50f42a53034457

可查询字段

运行CLI命令行工具,输入QueryIAM2OrganizationProjectRef并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例
{
  "inventories": [
    {
      "id": 1.0,
      "projectUuid": "29db1d979502319da9ecacb37168e0c6",
      "organizationUuid": "cd0af78809683f72b02a3fe8da0f1db0",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 3.6.0
inventories List 详情参考inventories 3.6.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 3.6.0
description String 错误的概要描述 3.6.0
details String 错误的详细信息 3.6.0
elaboration String 保留字段,默认为null 3.6.0
opaque LinkedHashMap 保留字段,默认为null 3.6.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 3.6.0
#inventories
名字 类型 描述 起始版本
projectUuid String 项目UUID 3.6.0
organizationUuid String 组织UUID 3.6.0
createDate Timestamp 创建时间 3.6.0
lastOpDate Timestamp 最后一次修改时间 3.6.0

SDK示例

Java SDK
QueryIAM2OrganizationProjectRefAction action = new QueryIAM2OrganizationProjectRefAction();
action.conditions = asList("projectUuid=a36c8328d0543cf09d51730a3ee5441f");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryIAM2OrganizationProjectRefAction.Result res = action.call();
Python SDK
QueryIAM2OrganizationProjectRefAction action = QueryIAM2OrganizationProjectRefAction()
action.conditions = ["projectUuid=287be9d5470a3a6b95c985de918c19f8"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryIAM2OrganizationProjectRefAction.Result res = action.call()

查询项目与账号关联关系(QueryIAM2ProjectAccountRef)

API请求

URLs
GET zstack/v1/iam2/projects/account/refs
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/projects/account/refs?q=projectUuid=d8b70d161b993f479cd737fbf74fe597

可查询字段

运行CLI命令行工具,输入QueryIAM2ProjectAccountRef并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例
{
  "inventories": [
    {
      "projectUuid": "84e2577b7dcd327792d89b5ea0869044",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 3.6.0
inventories List 详情参考inventories 3.6.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 3.6.0
description String 错误的概要描述 3.6.0
details String 错误的详细信息 3.6.0
elaboration String 保留字段,默认为null 3.6.0
opaque LinkedHashMap 保留字段,默认为null 3.6.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 3.6.0
#inventories
名字 类型 描述 起始版本
projectUuid String 项目UUID 3.6.0
accountUuid String 账户UUID 3.6.0
createDate Timestamp 创建时间 3.6.0
lastOpDate Timestamp 最后一次修改时间 3.6.0

SDK示例

Java SDK
QueryIAM2ProjectAccountRefAction action = new QueryIAM2ProjectAccountRefAction();
action.conditions = asList("projectUuid=e326155182fe367ab919c9282b261db7");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryIAM2ProjectAccountRefAction.Result res = action.call();
Python SDK
QueryIAM2ProjectAccountRefAction action = QueryIAM2ProjectAccountRefAction()
action.conditions = ["projectUuid=efd02b28577c3d6d855ebf27329757e2"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryIAM2ProjectAccountRefAction.Result res = action.call()

获取组织架构的成员数量(GetIAM2OrganizationVirtualIDNumber)

API请求

URLs
GET zstack/v1/iam2/organizations/{uuid}/virtualIDNumber
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/0572004dc33b36c4bd38216a024f5e0d/virtualIDNumber
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 4.0.0
systemTags (可选) List query 系统标签 4.0.0
userTags (可选) List query 用户标签 4.0.0

API返回

返回示例
{
  "virtualTotalNumber": 0.0,
  "virtualDirectNumber": 0.0
}
名字 类型 描述 起始版本
virtualTotalNumber Integer 4.0.0
virtualDirectNumber Integer 4.0.0
success boolean 4.0.0
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 4.0.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 4.0.0
description String 错误的概要描述 4.0.0
details String 错误的详细信息 4.0.0
elaboration String 保留字段,默认为null 4.0.0
opaque LinkedHashMap 保留字段,默认为null 4.0.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 4.0.0

SDK示例

Java SDK
GetIAM2OrganizationVirtualIDNumberAction action = new GetIAM2OrganizationVirtualIDNumberAction();
action.uuid = "0572004dc33b36c4bd38216a024f5e0d";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetIAM2OrganizationVirtualIDNumberAction.Result res = action.call();
Python SDK
GetIAM2OrganizationVirtualIDNumberAction action = GetIAM2OrganizationVirtualIDNumberAction()
action.uuid = "0572004dc33b36c4bd38216a024f5e0d"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetIAM2OrganizationVirtualIDNumberAction.Result res = action.call()

设置运营管理员(SetOrganizationOperation)

API请求

URLs
GET zstack/v1/iam2/organizations/{uuid}/operation
Headers
Authorization: OAuth the-session-uuid
Body
{
  "setOrganizationOperation": {
    "virtualIDUuid": "7c5f7a277d094ce2bb17a3e7c776c636"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"setOrganizationOperation":{"virtualIDUuid":"f8f5f4f72e5c47aab9a73aa5a1b6a1df"}}' http://localhost:8080/zstack/v1/iam2/organizations/8cf02a09ab864bcf883e19a1c06e6c7b/operation
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 4.3.6
virtualIDUuid String body(包含在setOrganizationOperation结构中) 用户uuid 4.3.6
systemTags (可选) List body 系统标签 4.3.6
userTags (可选) List body 用户标签 4.3.6

API返回

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

SDK示例

Java SDK
SetOrganizationOperationAction action = new SetOrganizationOperationAction();
action.uuid = "460a3e9f3d2047679e2bcdf3cb0a8c3a";
action.virtualIDUuid = "12d54783a9ee42d198135ee1929d91ec";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SetOrganizationOperationAction.Result res = action.call();
Python SDK
SetOrganizationOperationAction action = SetOrganizationOperationAction()
action.uuid = "673bd0eb6d0c4ef0b4c1dd2ef30ed82e"
action.virtualIDUuid = "543c2373e1da4c0cb76d232156db525f"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SetOrganizationOperationAction.Result res = action.call()

更新组织架构Quota(UpdateOrganizationQuota)

API请求

URLs
GET zstack/v1/iam2/Organization/quotas/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateOrganizationQuota": {
    "identityUuid": "3e083dfff99b309bb15e848f7acef41b",
    "name": "quota",
    "value": 100.0
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTagsuserTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateOrganizationQuota":{"identityUuid":"3e083dfff99b309bb15e848f7acef41b","name":"quota","value":100.0}}' http://localhost:8080/zstack/v1/iam2/Organization/quotas/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
identityUuid String body(包含在updateOrganizationQuota结构中) uuid 4.3.6
name String body(包含在updateOrganizationQuota结构中) quota名称 4.3.6
value long body(包含在updateOrganizationQuota结构中) 修改的值 4.3.6
systemTags (可选) List body 系统标签 4.3.6
userTags (可选) List body 用户标签 4.3.6

API返回

返回示例
{
  "inventory": {
    "name": "quota",
    "identityUuid": "09081c19d997357ca8f07b4c44ddc640",
    "value": 20.0
  }
}
名字 类型 描述 起始版本
success boolean 4.3.6
inventory QuotaInventory 详情参考inventory 4.3.6
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 4.3.6
#inventory
名字 类型 描述 起始版本
name String 资源名称 4.3.6
identityUuid String 身份UUID(账户UUID,用户UUID) 4.3.6
identityType String 身份类型(账户,用户) 4.3.6
value Long 默认配额值 4.3.6
lastOpDate Timestamp 最后一次修改时间 4.3.6
createDate Timestamp 创建时间 4.3.6
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 4.3.6
description String 错误的概要描述 4.3.6
details String 错误的详细信息 4.3.6
elaboration String 保留字段,默认为null 4.3.6
opaque LinkedHashMap 保留字段,默认为null 4.3.6
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 4.3.6

SDK示例

Java SDK
UpdateOrganizationQuotaAction action = new UpdateOrganizationQuotaAction();
action.identityUuid = "3e083dfff99b309bb15e848f7acef41b";
action.name = "quota";
action.value = 100.0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateOrganizationQuotaAction.Result res = action.call();
Python SDK
UpdateOrganizationQuotaAction action = UpdateOrganizationQuotaAction()
action.identityUuid = "3e083dfff99b309bb15e848f7acef41b"
action.name = "quota"
action.value = 100.0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateOrganizationQuotaAction.Result res = action.call()

获取组织架构的Quota(GetOrganizationQuotaUsage)

API请求

URLs
GET zstack/v1/iam2/organizations/quota/{uuid}/usages
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/quota/9636f37046a63657b26cb28ed8cbc38a/usages
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 4.3.6
systemTags (可选) List query 系统标签 4.3.6
userTags (可选) List query 用户标签 4.3.6

API返回

返回示例
{
  "usages": [
    {
      "name": "testquota",
      "total": 20.0,
      "used": 10.0
    }
  ]
}
名字 类型 描述 起始版本
success boolean 4.3.6
usages List 详情参考usages 4.3.6
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 4.3.6
#usages
名字 类型 描述 起始版本
name String 资源名称 4.3.6
total Long 配额总量 4.3.6
used Long 配额已用量 4.3.6
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 4.3.6
description String 错误的概要描述 4.3.6
details String 错误的详细信息 4.3.6
elaboration String 保留字段,默认为null 4.3.6
opaque LinkedHashMap 保留字段,默认为null 4.3.6
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 4.3.6

SDK示例

Java SDK
GetOrganizationQuotaUsageAction action = new GetOrganizationQuotaUsageAction();
action.uuid = "9636f37046a63657b26cb28ed8cbc38a";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetOrganizationQuotaUsageAction.Result res = action.call();
Python SDK
GetOrganizationQuotaUsageAction action = GetOrganizationQuotaUsageAction()
action.uuid = "9636f37046a63657b26cb28ed8cbc38a"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetOrganizationQuotaUsageAction.Result res = action.call()
开发手册 | 4.8.38 | ZStack Cloud · ZCF | ZStack 资源中心