文档

QueryWorkspaceUserList - 查询工作空间下的成员列表

更新时间:

查询指定工作空间下的成员列表信息。

调试

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

授权信息

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

请求参数

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

工作空间 ID。

95296e95-ca89-4c7d-8af9-dedf0ad0****
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 []

空间成员信息。

UserIdstring

Quick BI 用户 ID。

de4bc5f9429141cc8091cdd1c15b****
AccountIdstring

阿里云账号 ID。

16020915****8429
NickNamestring

昵称。

我就是那个分析师大神
AccountNamestring

阿里云账号名称。

pop****@aliyunid.test
Roleobject

空间成员的预置空间角色信息。

RoleCodestring

预置角色对应的编码。

role_workspace_admin
RoleNamestring

预置角色的名称。

管理员
RoleIdlong

预置角色 ID。取值范围:

  • 25:空间管理员
  • 26:空间开发者
  • 27:空间分析师
  • 30:空间查看者
25

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "TotalPages": 1,
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "Data": [
      {
        "UserId": "de4bc5f9429141cc8091cdd1c15b****",
        "AccountId": "16020915****8429",
        "NickName": "我就是那个分析师大神",
        "AccountName": "pop****@aliyunid.test",
        "Role": {
          "RoleCode": "role_workspace_admin",
          "RoleName": "管理员",
          "RoleId": 25
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.空间不在组织内。
400Workspace.Not.ExistThe group workspace does not exist.群空间不存在。
400Invalid.User.OrganizationThe user is not in your organization.该用户不在您的组织中。
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.该组织不存在。
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.操作组件不存在或已被删除。

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

  • 本页导读 (0)
文档反馈