ListWorkspaceRoleUsers - 获取指定空间角色下的用户列表_智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

获取指定空间角色下的用户列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RoleId	long	是	空间角色 ID，包括预置角色和自定义角色： 25：空间管理员（预置角色） 26：开发者（预置角色） 27：分析者（预置角色） 30：阅览者（预置角色）自定义角色：自定义角色对应的角色 ID	25
WorkspaceId	string	是	工作空间 ID。	726bee5a-****-43e1-9a8e-b550f0120f35
PageNum	integer	否	分页查询时的当前页：起始值：1 默认值：1	1
PageSize	integer	否	分页查询时的每页行数：默认值：10 最大值：1000	10
Keyword	string	否	用户昵称的关键字。	测试pop用户

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	返回空间角色下的用户列表。
Data	array<object>	用户列表。
Data	object	用户详情。
NickName	string	组织成员的昵称。	测试用户
UserId	string	组织成员在 Quick BI 的 UserID。	b5d8fd9348cc4327****afb604
WorkspaceId	string	工作空间 ID。	7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName	string	工作空间名称。	测试空间
PageNum	integer	页码。	1
PageSize	integer	请求接口时设置的每页行数。	10
TotalNum	integer	总行数。	1
TotalPages	integer	总页数。	1
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "NickName": "测试用户",
        "UserId": "b5d8fd9348cc4327****afb604\n",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "测试空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	Invalid.Workspace	The workspace is not owned by the organization.	该空间不在组织内。
400	User.Role.NotExist	User role not exist: %s.	用户角色不存在：%s。

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