QueryUserInfoByAccount - 根据账号查询用户信息

更新时间:
复制为 MD 格式

根据阿里云ID或阿里云账户名查询用户信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:QueryUserInfoByAccount

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Account

string

输入待查询的阿里云账号名或阿里云 ID。

  • 当输入账号名时:
    • 如果组织用户是主账号(例如 main_account),则查询账号格式为主账号。即,要输入的主账号 main_account。

    • 如果组织用户是子账号(例如 zhangsan@test.onaliyun.com),则查询账号格式为子账号的头部,即,要输入的子账号为 zhangsan。

  • 当输入阿里云 ID 时:
    • 输入完整的账号 UID,即可查询到对应的账号信息。

1386587****@163.com

ParentAccountName

string

当查询子账号出现重复报错时,输入主账号的账号名, 例如 zhangsan@test.onaliyun.com。

zhangsan@test.onaliyun.com

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885

Result

object

返回的组织用户信息。

AccountId

string

阿里云账号 ID。非 Ram 自助读取添加的用户,需要登录后才能获取到阿里云 ID。

135****5848

AccountName

string

阿里云账号名称。(子账号会去除@后面的域名信息,例如 test@test.com,会返回 test)

1386587****@163.com

AdminUser

boolean

是否绑定了组织管理员角色。取值范围:

  • true:是

  • false:否

重要 参数已过期不推荐使用,以 RoleIdList 参数为准

true

AuthAdminUser

boolean

是否绑定了权限管理员角色。取值范围:

  • true:是

  • false:否

重要 参数已过期不推荐使用,以 RoleIdList 参数为准

true

Email

string

邮箱。

1386587****@163.com

NickName

string

昵称。

测试用户

Phone

string

手机号码。

1386587****

RoleIdList

array

用户绑定的组织角色 ID 列表。

integer

组织角色 ID,最多 3 个,包括但不限于组织预置角色:

  • 组织管理员(预置角色):111111111

  • 权限管理员(预置角色):111111112

  • 普通用户(预置角色):111111113

111111111

UserId

string

Quick BI 中的 UserID。

fe67f61a35a94b7da1a34ba174a7****

UserType

integer

组织成员的用户类型。取值范围:

  • 1 :开发者

  • 2 :访问者

  • 3 :分析师

1

CopilotModules

array

所拥有配额的智能化模块

string

所拥有配额的智能化模块。

  • qreport --小 Q 报告

  • qExploreNum -- 小 Q 探索版

  • smartQAskNum -- 小 Q 问数

  • smartQDevNum -- 小 Q 搭建

qreport

Success

boolean

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

  • true:请求成功

  • false:请求失败

true

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccountId": "135****5848",
    "AccountName": "1386587****@163.com",
    "AdminUser": true,
    "AuthAdminUser": true,
    "Email": "1386587****@163.com",
    "NickName": "测试用户",
    "Phone": "1386587****",
    "RoleIdList": [
      111111111
    ],
    "UserId": "fe67f61a35a94b7da1a34ba174a7****",
    "UserType": 1,
    "CopilotModules": [
      "qreport"
    ]
  },
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 User.Duplicative Duplicate users found with account name : %s. 查询到重复的用户,账号名为:%s,。

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

变更历史

更多信息,参考变更详情