AddUser接口用于添加组织成员。

请求参数

名称 类型 是否必选 示例值 描述
Action String AddUser

要执行的操作。取值:AddUser。

AccountName String xxxxxx@163.com

阿里云账号名称。

  • 说明:如果是子账号,格式为『主账号:子账号』。例如:master_test@aliyun.com:subaccount
  • 格式检查:最大长度50个字符。
AdminUser Boolean true

是否是管理员。取值范围:

  • true:是
  • false:否
AuthAdminUser Boolean true

是否是权限管理员。取值范围:

  • true:是
  • false:否
NickName String 张三

阿里云账号昵称。

  • 格式检查:最大长度50个字符。
  • 特殊格式校验:中英文数字 _ \ / | () ] [
UserType Integer 1

组织成员的角色类型。取值范围:

  • 1 :开发者
  • 2 :访问者
  • 3 :分析师
AccountId String 132XXXX4846

阿里云账号ID。AccountId是可选值,如果传入,则生成Quick BI用户的UserId与之相同,否则系统会自动生成一个UserID。

返回数据

名称 类型 示例值 描述
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。

Result Struct

返回新增阿里云用户的详细信息。

AccountId String 132XXXX4846

阿里云账号ID。

AccountName String xxxxxx@163.com

阿里云账户。

AdminUser Boolean true

是否是管理员。取值范围:

  • true:是
  • false:否
AuthAdminUser Boolean true

是否是权限管理员。取值范围:

  • true:是
  • false:否
NickName String 张三

阿里云账号昵称。

UserId String fe67f61a35a94b7da1a34ba174a7****

Quick BI中的UserID。

UserType Integer 1

组织成员的角色类型。取值范围:

  • 1 :开发者
  • 2 :访问者
  • 3 :分析师
Success Boolean true

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=AddUser
&AccountName=xxxxxx@163.com
&AdminUser=true
&AuthAdminUser=true
&NickName=<张三>
&UserType=1
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>
    <AccountId>132XXXX4846</AccountId>
    <UserId>fe67f61a35a94b7da1a34ba174a7****</UserId>
    <AdminUser>true</AdminUser>
    <NickName>张三</NickName>
    <UserType>1</UserType>
    <AuthAdminUser>true</AuthAdminUser>
    <AccountName>xxxxxx@163.com</AccountName>
</Result>

JSON 格式

{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":{"AccountId":"132XXXX4846","UserId":"fe67f61a35a94b7da1a34ba174a7****","AdminUser":"true","NickName":"张三","UserType":"1","AuthAdminUser":"true","AccountName":"xxxxxx@163.com"}}

错误码

HttpCode 错误码 错误信息 描述
500 Invalid.Parameter An error occurred while verifying parameters. 参数验证失败。
500 Organization.Developers.ReachedTheUpperLimit The developers of the organization have reached the upper limit:%s 组织开发者已达到上限 %s 人,请升级联系组织管理员升级开发者数量。
500 Organization.Viewers.ReachedTheUpperLimit The visitors of the organization have reached the upper limit:%s. 组织访问者已达到上限%s人,请升级联系组织管理员升级访问者数量。
500 Organization.Analysts.ReachedTheUpperLimit The analysts of the organization have reached the upper limit:%s. 组织分析师已达到上限%s人,请升级联系组织管理员升级分析师数量。
500 Invalid.User.Admin You are not an administrator of this organization. 没有权限,您不是组织管理员。
500 NickName.AlreadyIn.Organization The alias already exists. 昵称已存在。
500 User.AlreadyIn.Organization This user is already a member of the current organization. 该用户已在当前组织中。
500 User.AlreadyIn.Organization The user already exists. 该用户已在其他组织中。
500 Invalid.User.Organization The user is not in your organization. 该用户不在您的组织中。
500 UserInfo.Error The personal information is invalid. 个人信息不合法。
500 Instance.Over.MaxLicense You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first. 您可以添加的用户已达上限,请升级配置或移除其它用户后再添加。
500 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止,您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

访问错误中心查看更多错误码。