文档

ListMembers - 获取工作空间的成员列表

更新时间:

获取工作空间的成员列表。

调试

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

授权信息

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

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

请求语法

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

请求参数

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

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

123
PageNumberlong

工作空间列表的页码。起始值为 1,默认为 1。

1
PageSizeinteger

分页查询时设置的每页行数。默认为 20。

20
Rolesstring

使用角色过滤成员,多个角色以半角逗号(,)分隔。 支持以下角色名:

  • PAI.AlgoDeveloper:算法开发。
  • PAI.AlgoOperator:算法运维。
  • PAI.LabelManager:标注管理员。
  • PAI.MaxComputeDeveloper:MaxCompute 开发。
  • PAI.WorkspaceAdmin:管理员。
  • PAI.WorkspaceGuest:访客。
  • PAI.WorkspaceOwner:负责人。
PAI.AlgoDeveloper
MemberNamestring

成员名,支持模糊匹配。

zhangsan

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Membersarray<object>

成员列表。

object

成员详情。

UserIdstring

用户 ID。

215139******88039
MemberNamestring

用户名。

user1
GmtCreateTimestring

创建 UTC 时间,时间格式为 ISO8601。

2021-01-21T17:12:35.232Z
Rolesarray

角色列表。

string

角色名。角色名和权限的对应关系,请参见附录:角色及权限列表

角色名可能值:

  • PAI.AlgoDeveloper:算法开发。
  • PAI.AlgoOperator:算法运维。
  • PAI.LabelManager:标注管理员。
  • PAI.MaxComputeDeveloper:MaxCompute 开发。
  • PAI.WorkspaceAdmin:管理员。
  • PAI.WorkspaceGuest:访客。
  • PAI.WorkspaceOwner:负责人。
PAI.AlgoDeveloper
DisplayNamestring

成员显示名。

myDisplayName
MemberIdstring

成员 ID。

14588*****51688039
TotalCountlong

符合过滤条件的成员数量。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Members": [
    {
      "UserId": "215139******88039",
      "MemberName": "user1",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "Roles": [
        "PAI.AlgoDeveloper"
      ],
      "DisplayName": "myDisplayName",
      "MemberId": "14588*****51688039"
    }
  ],
  "TotalCount": 1
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-11OpenAPI 返回结构发生变更查看变更详情