ListProjectMembers - 查询工作空间成员列表 - 大数据开发治理平台 DataWorks

该接口用于查询DataWorks工作空间中已存在成员的列表。

接口说明

前置条件：已开通 DataWorks 服务，调用账号已获得目标工作空间访问权限，并配置了调用 OpenAPI 所需的 RAM 权限。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListProjectMembers

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ProjectId	integer	是	DataWorks 工作空间的 ID。	27
PageNumber	integer	否	分页的页数。默认值为 1，最小值为 1，最大值为 30。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大 100 条。	10

返回参数

名称	类型	描述	示例值
	object	返回结果。
Data	object	查询结果。
PageNumber	integer	当前的页码。	1
PageSize	integer	每页的大小。	10
ProjectMemberList	array<object>	工作空间的成员列表。
	array<object>	成员详情。
Nick	string	工作空间成员的昵称。	zhangsan
ProjectMemberId	string	成员的用户 ID。	121
ProjectMemberName	string	成员的名称。	张三
ProjectMemberType	string	成员的类型，取值如下： 1：阿里云主账号（USER_ALIYUN）； 5：RAM USER 子账号（USER_UBACCOUNT）； 6：RAM ROLE 角色（USER_STS_ROLE）。	1
ProjectRoleList	array<object>	成员所拥有的角色列表。
	object	返回数据结构。
ProjectRoleCode	string	角色 Code。 DataWorks 为您提供了预设角色，您也可以根据业务需求自定义角色。角色更多详情，请参见用户、角色与权限概述。	role_project_guest
ProjectRoleId	integer	角色 ID。	1
ProjectRoleName	string	角色的名称。 DataWorks 为您提供了预设角色，您也可以根据业务需求自定义角色。角色更多详情，请参见用户、角色与权限概述。	访客
ProjectRoleType	string	角色的类型。取值如下： SYSTEM（0）：系统角色； USER_CUSTOM（2）：自定义角色。	0
Status	string	查询状态。取值如下： 0 ，表示正常（NORMAL）。 1，表示禁用（FORBIDDEN）。 2，表示已删除（DELETED）。	0
TotalCount	integer	结果的总条数。	3
RequestId	string	请求 ID。	1AFAE64E-D1BE-432B-A9****

示例

正常返回示例

JSON格式

{
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "ProjectMemberList": [
      {
        "Nick": "zhangsan",
        "ProjectMemberId": "121",
        "ProjectMemberName": "张三",
        "ProjectMemberType": "1",
        "ProjectRoleList": [
          {
            "ProjectRoleCode": "role_project_guest",
            "ProjectRoleId": 1,
            "ProjectRoleName": "访客",
            "ProjectRoleType": "0"
          }
        ],
        "Status": "0"
      }
    ],
    "TotalCount": 3
  },
  "RequestId": "1AFAE64E-D1BE-432B-A9****"
}

错误码

HTTP status code	错误码	错误信息	描述
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	数据源不存在。
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	项目不存在。
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	用户不在项目中。
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	用户不是项目负责人或者项目管理员。
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	用户不在租户中。

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

变更历史

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