文档

ListWorkspaceUsers - 获取工作空间用户列表

更新时间:

列出未加入工作空间的用户列表,这些用户可被加入工作空间成为成员。

调试

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

授权信息

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

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

请求语法

GET /api/v1/workspaces/{WorkspaceId}/users

请求参数

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

工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

12345
UserNamestring

支持添加为工作空间成员的用户显示名称。

doctest****

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求 ID。

1e195c5116124202371861018d5bde
TotalCountlong

符合过滤条件的用户数量。

2
Usersarray<object>

用户列表。

object

用户。

UserIdstring

用户 ID。

1611******3000
UserNamestring

用户名。

she******mo

示例

正常返回示例

JSON格式

{
  "RequestId": "1e195c5116124202371861018d5bde",
  "TotalCount": 2,
  "Users": [
    {
      "UserId": "1611******3000",
      "UserName": "she******mo"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-11OpenAPI 入参发生变更查看变更详情