文档

QueryUserList - 查询组织成员列表信息

更新时间:

查询组织成员列表信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Keywordstring

组织成员用户名或昵称的关键字。

测试用户
PageNuminteger

组织成员列表的当前页码:

  • 起始值:1
  • 默认值:1
1
PageSizeinteger

分页查询时的每页行数:

  • 默认值:10
  • 最大值:1000
10

返回参数

名称类型描述示例值
object
Successboolean

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

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

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

返回用户列表的分页结果,组织成员的详细信息列表存放在返回参数 Data 中。

TotalPagesinteger

总页数。

1
PageNuminteger

页码。

1
PageSizeinteger

请求接口时设置的每页行数。

10
TotalNuminteger

总行数。

1
Dataobject []

返回请求的用户列表。

UserTypeinteger

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

  • 1 :开发者
  • 2 :访问者
  • 3 :分析师
1
UserIdstring

Quick BI 中的 UserID。

fe67f61a35a94b7da1a34ba174a7****
AuthAdminUserboolean

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

  • true:是
  • false:否
true
AccountIdstring

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

1355********
NickNamestring

组织成员的昵称。

测试用户
AdminUserboolean

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

  • true:是
  • false:否
true
AccountNamestring

阿里云账号名称。

测试用户

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "TotalPages": 1,
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "Data": [
      {
        "UserType": 1,
        "UserId": "fe67f61a35a94b7da1a34ba174a7****",
        "AuthAdminUser": true,
        "AccountId": "1355********",
        "NickName": "测试用户",
        "AdminUser": true,
        "AccountName": "测试用户",
        "RoleIdList": [
          0
        ]
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。

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

变更历史

变更时间变更内容概要操作
2024-02-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈