调用ListProjectMembers查询DataWorks工作空间中已存在成员的列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListProjectMembers

系统规定参数。取值:ListProjectMembers

RegionId String cn-shanghai

工作空间所在地域的ID。

ProjectId Long 27

Dataworks工作空间的ID。

PageNumber Integer 1

分页查询时的页码。

PageSize Integer 10

分页查询时,每页的大小。取值范围:1~100。

返回数据

名称 类型 示例值 描述
RequestId String 1AFAE64E-D1BE-432B-A9****

请求ID。

Data Object

查询结果。

PageNumber Integer 1

当前的页码。

PageSize Integer 10

每页的大小。

TotalCount Integer 3

结果的总条数。

ProjectMemberList Array of ProjectMember

工作空间的成员列表。

Status String 0

查询状态。包括NARMAL(0) 正常、FORBIDDEN(1) 禁用、DELETED(2) 已删除。

ProjectMemberId String 121

成员的用户ID。

Nick String zhangsan

工作空间成员的昵称。

ProjectMemberName String 张三

成员的名称。

ProjectMemberType String 0

成员的类型。

ProjectRoleList Array of Role

成员所拥有的角色列表。

ProjectRoleId Integer 1

角色ID。

ProjectRoleType String 0

角色的类型。取值如下:

  • SYSTEM(0):系统角色。
  • USER_CUSTOM(2):自定义角色。
ProjectRoleName String 访客

角色的名称。

ProjectRoleCode String role_project_guest

角色Code。

示例

请求示例

http(s)://[Endpoint]/?Action=ListProjectMembers
&ProjectId=27
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListProjectMembersResponse>
    <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>3</TotalCount>
        <ProjectMemberList>
            <Status>0</Status>
            <ProjectMemberId>121</ProjectMemberId>
            <Nick>zhangsan</Nick>
            <ProjectMemberName>张三</ProjectMemberName>
            <ProjectMemberType>0</ProjectMemberType>
            <ProjectRoleList>
                <ProjectRoleId>1</ProjectRoleId>
                <ProjectRoleType>0</ProjectRoleType>
                <ProjectRoleName>访客</ProjectRoleName>
                <ProjectRoleCode>role_project_guest</ProjectRoleCode>
            </ProjectRoleList>
        </ProjectMemberList>
    </Data>
</ListProjectMembersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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. 用户不在租户中。

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