ListWorkspaceRoleUsers - 获取指定空间角色下的用户列表 - 智能商业分析 Quick BI

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:ListWorkspaceRoleUsers

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RoleId	integer	是	空间角色 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>	用户列表。
	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.

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

变更历史

更多信息，参考变更详情。