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

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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 中。

Dataarray<object>

空间成员信息。

Dataobject
AccountIdstring

阿里云账号 ID。

16020915****8429
AccountNamestring

阿里云账号名称。

pop****@aliyunid.test
NickNamestring

昵称。

我就是那个分析师大神
Roleobject

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

RoleCodestring

预置角色对应的编码。

role_workspace_admin
RoleIdlong

预置角色 ID。取值范围:

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

预置角色的名称。

管理员
UserIdstring

Quick BI 用户 ID。

de4bc5f9429141cc8091cdd1c15b****
PageNuminteger

页码。

1
PageSizeinteger

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

10
TotalNuminteger

总行数。

1
TotalPagesinteger

总页数。

1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.空间不在组织内。
400Workspace.Not.ExistThe group workspace does not exist.群空间不存在。

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