文档目录

用户管理

概览

子账户:子账户由admin创建或统一认证系统同步,且受admin管理,子账户对自己创建的虚拟资源拥有管理权限。子账户对作用域的资源可以进行创建、删除等操作,实现对资源归属及权限控制的细粒度划分。

图 1所示:
图 1. 子账户设置


相关定义

  • 账户
    • admin账户
      • admin账户不受权限控制,拥有超级权限,通常由IT系统管理员拥有。
      • admin账户可以共享计算规格、云盘规格、网络、镜像等资源给子账户,也可以对相关资源进行召回,不再共享。
      • admin账户可以通过修改配额对子账户进行资源总量控制。
      • admin账户创建VxlanNetworkPool后,子账户可以基于VxlanNetworkPool创建VxlanNetwork。
      • 更改云主机所有者会更改云主机的EIP所有者属性。
    • 子账户
      • 子账户可分为本地子账户和统一认证子账户:
        • 本地子账户由admin账户直接创建,统一认证子账户由统一认证服务器同步至云平台。
          • 统一认证SSO:云平台提供的统一认证登录服务,支持无缝接入统一认证登录系统,相应账户将免密登录云平台,便捷使用云资源,目前支持添加OIDC服务器。
            • OIDC 服务器:基于OIDC协议建构的统一认证服务器,可认证并授权统一认证用户免密登录云平台,并将用户信息按照映射规则同步至云平台。
      • 子账户对自己创建的云主机、镜像、云盘、安全组等资源拥有管理权限。
      • 子账户可以对admin账户共享的资源进行读操作,但不可以进行删除操作。
      • 删除子账户会导致此账户下的所有资源被删除,例如,云主机、云盘、镜像等。
      • 子账户名称不可重复。
      • 子账户首页看到的资源受admin账户分配的资源配额限制。
      • 子账户创建云主机前,需要admin账户提前共享计算规格、网络和云盘规格等资源,否则不可创建云主机。
      • 子账户可以添加自有的镜像文件,也可由admin账户提前共享。
  • 配额
    • 又称子账户配额,是admin账户对子账户的资源总量进行控制的衡量标准,包括计算资源、存储资源、网络资源和其它资源。
    • admin账户通过配置参数来对各个普通账户的资源总额进行控制。若执行资源删除操作,但还未彻底删除时,会占用主存储资源和云盘数量。

清单

属性

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见资源结构 0.6
name 请参见资源结构 0.6
description 请参见资源结构 0.6
state 请参见资源结构
  • Enabled
  • Disabled
0.6
createDate 请参见资源结构 0.6
lastOpDate 请参见资源结构 0.6
type 保留域 0.6

示例

{
    "inventories": [
        {
            "createDate": "Mar 10, 2018 2:13:11 PM",
            "lastOpDate": "Mar 10, 2018 2:13:11 PM",
            "name": "admin",
            "type": "SystemAdmin",
            "uuid": "36c27e8ff05c4780bf6d2fa65700f22e"
        }
    ],
    "success": true
}

双因子认证密钥清单(TwoFactorAuthentication inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.4.0
secret 双因子认证密钥 3.4.0
userUuid 用户UUID 3.4.0
userType 用户类型 3.4.0
status 状态 3.4.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 3.4.0
createDate 请参见 资源属性 3.4.0
lastOpDate 请参见 资源属性 3.4.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.4.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.4.0
示例
{
    "inventories": [
        {
            "createDate": "Mar 12, 2019 7:50:41 PM",
            "lastOpDate": "Mar 12, 2019 7:50:41 PM",
            "secret": "75BLH2NDTNIVE364",
            "status": "NewCreated",
            "userType": "AccountVO",
            "userUuid": "2dce5dc485554d21a3796500c1db007a",
            "uuid": "060a5b419c894c0bbc57e7e6ca2084fd"
    }
  ]
}

账户清单(Account inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 0.6
name 请参见资源属性 0.6
description 请参见资源属性 0.6
type 账户类型(管理员,普通账户) 0.6
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
示例
{
  "inventories": [
    {
      "uuid": "c5962adc77ff40d980bcfe68a39b6fc5",
      "name": "test",
      "type": "Normal"
    }
  ]
}

账户资源引用清单(AccountResourceRef inventory)

名字 描述 可选的 可选的参数值 起始支持版本
accountUuid 账户UUID 0.6
resourceUuid 资源UUID 0.6
resourceType 资源类型 0.6
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
示例
{
  "inventories": [
    {
      "id": 1.0,
      "accountUuid": "a27e124c2a8441be8212a622848c28cd",
      "ownerAccountUuid": "b22d5d9b1c084589aa1abe30d2783bb8",
      "resourceUuid": "c2fa286ab4ac41f18ce5219cc4482641",
      "resourceType": "ImageVO",
      "permission": 1.0,
      "isShared": false
    }
  ]
}

用户组清单(UserGroup inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 0.6
name 请参见资源属性 0.6
description 请参见资源属性 0.6
accountUuid 账户UUID 0.6
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
示例
{
"inventories": [
    {
"uuid": "775eb58ab79a41c9803cc8ffc4996f80",
"accountUuid": "a3511b57fa06498b85c6c7150770120e",
"name": "usergroup"
    }
  ]
}

用户清单(User inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 0.6
name 请参见资源属性 0.6
description 请参见资源属性 0.6
accountUuid 账户UUID 0.6
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
示例
{
"inventories": [
    {
"uuid": "b369a13fbbf64812802612040590a682",
"accountUuid": "9cf0fc6c3d8146dab03a5727da5ebe2b",
"name": "testuser"
    }
  ]
}

策略清单(Policy inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 0.6
name 请参见资源属性 0.6
accountUuid 账户UUID 0.6
statements 0.6
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
示例
{
"inventories": [
    {
"statements": [
        {
"name": "user-reset-password-10e0d5dc0a4846c8b7e2e204aa014370",
"effect": "Allow",
"actions": [
"identity:APIUpdateUserMsg"
          ]
        }
      ],
"name": "USER-RESET-PASSWORD",
"uuid": "10e0d5dc0a4846c8b7e2e204aa014370",
"accountUuid": "2884beb74bff43569096365a90e696fb"
    }
  ]
}

配额清单(Quota inventory)

名字 描述 可选的 可选的参数值 起始支持版本
name 请参见资源属性 0.6
identityUuid 身份UUID(账户UUID,用户UUID) 0.6
identityType 身份类型(账户,用户) 0.6
value 默认配额值 0.6
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
示例
{
"inventories": [
    {
"name": "quota",
"identityUuid": "bdb6f9724a0d40d69ffa47856a916f93",
"value": 20.0
    }
  ]
}

共享资源清单(SharedResource inventory)

名字 描述 可选的 可选的参数值 起始支持版本
ownerAccountUuid 所有者账户UUID 0.6
receiverAccountUuid 接受者账户UUID 0.6
toPublic 是否全局共享 0.6
resourceType 资源类型 0.6
resourceUuid 资源UUID 0.6
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
示例
{
"inventories": [
    {
"ownerAccountUuid": "459f08b3915d4c06817e36587bd91fbb",
"receiverAccountUuid": "3de68725726544209999d5ec8172926e",
"toPublic": false,
"resourceType": "ImageVO",
"resourceUuid": "01f2f1309e9f4d67955a0648df6963a0"
    }
  ]
}

操作(Operations)

创建账户(CreateAccount)

管理员可以使用CreateAccount创建账户。例如:
CreateAccount name=normal password=password

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 0.6
password 密码 0.6
type 账户类型
  • SystemAdmin
  • Normal
0.6
description 资源的详细描述 0.6
resourceUuid 资源uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 AccountVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 AccountVO 0.6
timeout

删除账户(DeleteAccount)

管理员可以使用DeleteAccount删除账户。例如:
DeleteAccount uuid=fb955f42278149a7b93e238a8c8bd272

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源uuid 0.6
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive
  • Enforcing
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 AccountVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) ;资源类型是 AccountVO 0.6
timeout

查询账户(QueryAccount)

管理员可以使用QueryAccount查询账户。例如:
QueryAccount uuid=c1a0038cfc004f59bf7a56c6da8d856b
QueryAccount user.uuid=523024a60fb4437ab141ce965eb50f05

原生域查询(Primitive Fields of Query)

请参见账户清单(Account inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
group group inventory 0.6
policy policy inventory 0.6
quota quota inventory 0.6
user user inventory 0.6

更新账户(UpdateAccount)

管理员可以使用UpdateAccount更新账户。例如:
UpdateAccount uuid=f536739a077040afa74af59ac085252b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 账户uuid 0.6
name 账户名称 0.6
password 密码 0.6
description 资源的详细描述 0.6
resourceUuid 资源uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 AccountVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 AccountVO 0.6
timeout

使用账户身份登录(LogInByAccount)

管理员可以使用LogInByAccount以账户身份登录云平台。例如:
LogInByAccount accountName=account1 password=password
# 使用双因子登录验证
LogInByAccount accountName=account1 password=password systemTags=twofatoken::123456

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
accountName 账户名称 0.6
password 密码 0.6
captchaUuid 验证码UUID 2.6.0
verifyCode 验证码 2.6.0
clientInfo 客户端信息 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 AccountVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 AccountVO 0.6
timeout
Note:
  • ZStack Cloud使用账户身份登录时支持双因子登录验证,SystemTags增加twofatoken选项。
    • 选项格式为:twofatoken::双因子验证6位安全码
    • 例如:twofatoken::123456

获取登录验证码(GetLoginCaptcha)

管理员可以使用GetLoginCaptcha获取登录验证码。例如:
GetLoginCaptcha resourceName=admin loginType=Test

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
resourceName 资源名称 2.6.0
loginType 登录类型 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 AccountVO 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 AccountVO 2.6.0
timeout

刷新验证码(RefreshCaptcha)

管理员可以使用RefreshCaptcha刷新验证码。例如:
RefreshCaptcha uuid=4f9643d18f34440babd971793f6d0b3a

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 AccountVO 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 AccountVO 2.6.0
timeout

获取双因子认证密钥(GetTwoFactorAuthenticationSecret)

管理员可以使用GetTwoFactorAuthenticationSecret获取双因子认证密钥。例如:
GetTwoFactorAuthenticationSecret name=admin password=password type=account

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 2.6.0
password 2.6.0
type
  • account
  • iam2
2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 AccountVO 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 AccountVO 2.6.0
timeout

查询双因子认证密钥(QueryTwoFactorAuthentication)

管理员可以使用QueryTwoFactorAuthentication查询双因子认证密钥。例如:
QueryTwoFactorAuthentication uuid=b86c9016b4f24953a9edefb53ca0678c

原生域查询(Primitive Fields of Query)

请参见双因子认证密钥清单(TwoFactorAuthentication inventory)

获取双因子认证状态(GetTwoFactorAuthenticationState)

管理员可以使用GetTwoFactorAuthenticationState获取双因子认证状态。例如:
GetTwoFactorAuthenticationState 

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 AccountVO 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 AccountVO 2.6.0
timeout

获取账户配额使用情况(GetAccountQuotaUsage)

管理员可以使用GetAccountQuotaUsage获取账户配额使用情况。例如:
GetAccountQuotaUsage uuid=c1a0038cfc004f59bf7a56c6da8d856b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 AccountVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 AccountVO 0.6
timeout

查询账户资源引用(QueryAccountResourceRef)

管理员可以使用QueryAccountResourceRef查询账户资源引用。例如:
QueryAccountResourceRef accountUuid=36c27e8ff05c4780bf6d2fa65700f22e resourceType=VolumeVO

原生域查询(Primitive Fields of Query)

请参见账户资源引用清单(AccountResourceRef inventory)

共享资源给账户(ShareResource)

管理员可以使用ShareResource共享资源给账户。例如:
ShareResource resourceUuids=e29e00c1d18a486b8802a8f53c6a6e4f /
accountUuids=f536739a077040afa74af59ac085252b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
resourceUuids 资源uuid列表 0.6
accountUuids 账户uuid列表 0.6
toPublic 全局共享;toPublic参数被设为false时,账户uuid不能为空 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
timeout

查看资源所属账户(GetResourceAccount)

管理员可以使用GetResourceAccount查看资源所属账户。例如:
GetResourceAccount resourceUuids=c1a0038cfc004f59bf7a56c6da8d856b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
resourceUuids 资源uuid 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

创建用户组(CreateUserGroup)

管理员可以使用CreateUserGroup创建用户组。例如:
CreateUserGroup name=usergroup1

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 0.6
description 资源的详细描述 0.6
resourceUuid 资源uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserGroupVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserGroupVO 0.6
timeout

删除用户组(DeleteUserGroup)

管理员可以使用DeleteUserGroup删除用户组。例如:
DeleteUserGroup uuid=f0f6fc4d36a341e3a61b560bd176b351

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源uuid 0.6
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive
  • Enforcing
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserGroupVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) ;资源类型是 UserGroupVO 0.6
timeout

查询用户组(QueryUserGroup)

管理员可以使用QueryUserGroup查询用户组。例如:
QueryUserGroup accountUuid=f536739a077040afa74af59ac085252b
QueryUserGroup accountUuid=f536739a077040afa74af59ac085252b

原生域查询(Primitive Fields of Query)

请参见用户组清单(UserGroup inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
account account inventory 用户组所属的账户 0.6
policy policy inventory 用户组绑定的策略 0.6
user user inventory 用户组中的用户 0.6

更新用户组(UpdateUserGroup)

管理员可以使用UpdateUserGroup更新用户组。例如:
UpdateUserGroup uuid=101a72b491024d8fba5a946a9fb5ddb0

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源uuid 0.6
name 资源名称 0.6
description 资源的详细描述 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserGroupVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserGroupVO 0.6
timeout

添加到用户组(AddUserToGroup)

管理员可以使用AddUserToGroup添加到用户组。例如:
AddUserToGroup groupUuid=42a53ca7dec74b538bdbee48caa6e27a \
userUuid=ec6f8785d7344214a0e9adf94790aebe

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userUuid 用户uuid 0.6
groupUuid 用户组uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserGroupVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserGroupVO 0.6
timeout

绑定策略到用户组(AttachPolicyToUserGroup)

管理员可以使用AttachPolicyToUserGroup绑定策略到用户组。例如:
AttachPolicyToUserGroup groupUuid=101a72b491024d8fba5a946a9fb5ddb0 \
policyUuid=ffb698fe5c7d41b1a913fc3cb83e234c

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
policyUuid 权限策略uuid 0.6
groupUuid 用户组uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserGroupVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserGroupVO 0.6
timeout

将策略从用户组解绑(DetachPolicyFromUserGroup)

管理员可以使用DetachPolicyFromUserGroup将策略从用户组解绑。例如:
DetachPolicyFromUserGroup groupUuid=101a72b491024d8fba5a946a9fb5ddb0 \
policyUuid=ffb698fe5c7d41b1a913fc3cb83e234c

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
policyUuid 权限策略uuid 0.6
groupUuid 用户组uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserGroupVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserGroupVO 0.6
timeout

从用户组中移除用户(RemoveUserFromGroup)

管理员可以使用RemoveUserFromGroup从用户组中移除用户。例如:
RemoveUserFromGroup groupUuid=101a72b491024d8fba5a946a9fb5ddb0 \
userUuid=523024a60fb4437ab141ce965eb50f05

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userUuid 用户uuid 0.6
groupUuid 用户组uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserGroupVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserGroupVO 0.6
timeout

创建用户(CreateUser)

管理员可以使用CreateUser创建用户。例如:
CreateUser name=user password=password

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 用户名称 0.6
password 密码 0.6
description 资源的详细描述 0.6
resourceUuid 资源uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserVO 0.6
timeout

删除用户(DeleteUser)

管理员可以使用DeleteUser删除用户。例如:
DeleteUser uuid=c9b34d9721394c45b6a70529f0aeb39b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源uuid 0.6
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive
  • Enforcing
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) ;资源类型是 UserVO 0.6
timeout

查询用户(QueryUser)

管理员可以使用QueryUser查询用户。例如:
QueryUser accountUuid=36c27e8ff05c4780bf6d2fa65700f22e
QueryUser account.uuid=36c27e8ff05c4780bf6d2fa65700f22e

原生域查询(Primitive Fields of Query)

请参见用户清单(User inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
account account inventory 用户所属的账户 0.6
policy policy inventory 用户绑定的策略 0.6
group group inventory 用户所在的用户组 0.6

更新用户(UpdateUser)

管理员可以使用UpdateUser更新用户。例如:
UpdateUser uuid=523024a60fb4437ab141ce965eb50f05

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源uuid 0.6
name 用户名称 0.6
password 密码 0.6
description 资源的详细描述 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserVO 0.6
timeout

使用用户身份登录(LogInByUser)

管理员可以使用LogInByUser使用用户身份登录。例如:
LogInByUser userName=12user password=password accountName=12

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
accountUuid 账户uuid 0.6
accountName 账户名称 0.6
userName 用户名称 0.6
password 密码 0.6
clientInfo 客户端信息 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserVO 0.6
timeout

绑定一条策略到用户(AttachPolicyToUser)

管理员可以使用AttachPolicyToUser绑定一条策略到用户。例如:
AttachPolicyToUser userUuid=5fb5b7ba87fb4c07ad3ec89ed0b41379 \
policyUuid=8dadd2b163c14d639e03ea9c8bc17b9f

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userUuid 用户uuid 0.6
policyUuid 权限策略uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserVO 0.6
timeout

将一条策略从用户解绑(DetachPolicyFromUser)

管理员可以使用DetachPolicyFromUser将一条策略从用户解绑。例如:
DetachPolicyFromUser policyUuid=8dadd2b163c14d639e03ea9c8bc17b9f \
userUuid=5fb5b7ba87fb4c07ad3ec89ed0b41379

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userUuid 用户uuid 0.6
policyUuid 权限策略uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserVO 0.6
timeout

绑定多条策略到用户(AttachPoliciesToUser)

管理员可以使用AttachPoliciesToUser绑定多条策略到用户。例如:
AttachPoliciesToUser userUuid=5fb5b7ba87fb4c07ad3ec89ed0b41379 \
policyUuids=9e092aafa9a14af187d67b4072dd8eda,5cde60162d6e4f9a8e1984bd0fda542b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userUuid 用户uuid 0.6
policyUuids 权限策略uuid列表 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserVO 0.6
timeout

将多条策略从用户解绑(DetachPoliciesFromUser)

管理员可以使用DetachPoliciesFromUser将多条策略从用户解绑。例如:
DetachPoliciesFromUser userUuid=5fb5b7ba87fb4c07ad3ec89ed0b41379 \
policyUuids=9e092aafa9a14af187d67b4072dd8eda,5cde60162d6e4f9a8e1984bd0fda542b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userUuid 用户uuid 0.6
policyUuids 权限策略uuid列表 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 UserVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 UserVO 0.6
timeout

创建策略(CreatePolicy)

管理员可以使用CreatePolicy创建策略。例如:
CreatePolicy name=all statements='[{"actions":[".*"], "effect":"Allow"}]'

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 0.6
description 资源的详细描述 0.6
statements 策略声明 0.6
resourceUuid 资源uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 PolicyVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 PolicyVO 0.6
timeout

删除策略(DeletePolicy)

管理员可以使用DeletePolicy删除策略。例如:
DeletePolicy uuid=9e092aafa9a14af187d67b4072dd8eda

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源uuid 0.6
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive
  • Enforcing
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 PolicyVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) ;资源类型是 PolicyVO 0.6
timeout

查询策略(QueryPolicy)

管理员可以使用QueryPolicy查询策略。例如:
QueryPolicy uuid=5cde60162d6e4f9a8e1984bd0fda542b
QueryPolicy account.uuid=2cfc587668474aa9ae544c014bfbd36e

原生域查询(Primitive Fields of Query)

请参见策略清单(Policy inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
account account inventory 0.6
group group inventory 0.6
user user inventory 0.6

查询配额(QueryQuota)

管理员可以使用QueryQuota查询配额。例如:
QueryQuota name=vm.num
QueryQuota account.uuid=f536739a077040afa74af59ac085252b

原生域查询(Primitive Fields of Query)

请参见配额清单(Quota inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
account account inventory 0.6

更新配额(UpdateQuota)

管理员可以使用UpdateQuota更新配额。例如:
UpdateQuota identityUuid=f536739a077040afa74af59ac085252b name=vm.num value=25

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
identityUuid 身份实体的uuid(账户的) 0.6
name 资源名称 0.6
value 配额值 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 QuotaVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 QuotaVO 0.6
timeout

获取资源名称(GetResourceNames)

管理员可以使用GetResourceNames获取资源名称。例如:
GetResourceNames uuids=bd73a3d1e6784d49897be5ae785305d8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuids 资源uuid列表 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 ResourceVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 ResourceVO 0.6
timeout

查询共享资源(QuerySharedResource)

管理员可以使用QuerySharedResource查询共享资源。例如:
QuerySharedResource resourceUuid=6ec89e13f4a05ed4be42dabfcdad6dd7

原生域查询(Primitive Fields of Query)

请参见共享资源清单(SharedResource inventory)

解除资源共享(RevokeResourceSharing)

管理员可以使用RevokeResourceSharing解除资源共享。例如:
RevokeResourceSharing resourceUuids=6ec89e13f4a05ed4be42dabfcdad6dd7 all=true

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
resourceUuids 资源uuid列表 0.6
toPublic 全局共享 0.6
accountUuids 账户uuid列表 0.6
all all参数被设为false时,账户uuid不能为空 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
timeout

变更资源所有者(ChangeResourceOwner)

管理员可以使用ChangeResourceOwner变更资源所有者。例如:
ChangeResourceOwner accountUuid=2cfc587668474aa9ae544c014bfbd36e \
resourceUuid=1ad7f7f385d64e2fb7531ee3a06bcf8d

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
accountUuid 账户uuid 0.6
resourceUuid 资源uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
timeout

检查API权限(CheckApiPermission)

管理员可以使用CheckApiPermission检查API权限。例如:
CheckApiPermission apiNames=org.zstack.storage.primary.local.APIQueryLocalStorageResourceRefMs

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userUuid 用户uuid 0.6
apiNames API名称列表 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
timeout

验证会话的有效性(ValidateSession)

管理员可以使用ValidateSession验证会话的有效性。例如:
ValidateSession sessionUuid=7f69ae7ed38941adb54ba8777ae68cb5

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
sessionUuid 会话uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
timeout

退出当前登录状态(LogOut)

管理员可以使用LogOut退出当前登录状态。例如:
LogOut sessionUuid=d22049be779b455f86bc3484becad10f

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
sessionUuid 会话uuid 0.6
clientInfo 客户端信息 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 0.6
timeout

更新会话(RenewSession)

管理员可以使用RenewSession更新会话。例如:
RenewSession sessionUuid=7b93b7648aea3c8d9109498a32288470

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
duration 2.3
sessionUuid 会话uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 PolicyVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) ;资源类型是 PolicyVO 0.6
timeout

标签(Tags)

用户可以使用CreateUserTag resourceType=UserTagVO在用户上创建用户标签。 例如:
CreateUserTag resourceType=UserTagVO tag=Test1 \
resourceUuid=3214e0dcd01d4e2aa8407968e1c51d58
CLI命令使用手册 | 4.8.38 | ZStack Cloud · ZCF | ZStack 资源中心