Queries members in a DataWorks workspace.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListProjectMembers

The operation that you want to perform. Set the value to ListProjectMembers.

RegionId String Yes cn-shanghai

The region ID of the DataWorks workspace.

ProjectId Long Yes 27

The ID of the DataWorks workspace.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 100.

Response parameters

Parameter Type Example Description
RequestId String 1AFAE64E-D1BE-432B-A9****

The ID of the request.

Data Object

The query results.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

TotalCount Integer 3

The total number of entries returned.

ProjectMemberList Array of ProjectMember

The information of members in the DataWorks workspace.

Status String 0

The status of the member. Valid values: NORMAL (0), FORBIDDEN (1), and DELETED (2). The value NORMAL (0) indicates that the member is in a normal state. The value FORBIDDEN (1) indicates that the member is in the forbidden state. The value DELETED(2) indicates that the member is in the deleted state.

ProjectMemberId String 121

The ID of the member.

Nick String zhangsan

The nickname of the member.

ProjectMemberName String Tom

The name of the member.

ProjectMemberType String 0

The type of the member.

ProjectRoleList Array of Role

The roles that are assigned to the member.

ProjectRoleId Integer 1

The ID of the role.

ProjectRoleType String 0

The type of the role. Valid values:

  • SYSTEM (0): system role
  • USER_CUSTOM (2): custom role
ProjectRoleName String Visitor

The name of the role.

ProjectRoleCode String role_project_guest

The code of the role.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListProjectMembers
&ProjectId=27
&PageNumber=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

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>Tom</ProjectMemberName>
            <ProjectMemberType>0</ProjectMemberType>
            <ProjectRoleList>
                <ProjectRoleId>1</ProjectRoleId>
                <ProjectRoleType>0</ProjectRoleType>
                <ProjectRoleName>Visitor</ProjectRoleName>
                <ProjectRoleCode>role_project_guest</ProjectRoleCode>
            </ProjectRoleList>
        </ProjectMemberList>
    </Data>
</ListProjectMembersResponse>

JSON format

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" : "Tom",
      "ProjectMemberType" : 0,
      "ProjectRoleList" : {
        "ProjectRoleId" : 1,
        "ProjectRoleType" : 0,
        "ProjectRoleName" : "Visitor",
        "ProjectRoleCode" : "role_project_guest"
      }
    }
  }
}

Error codes

HTTP status code Error code Error message Description
400 Invalid.Tenant.ConnectionNotExists The connection does not exist. The error message returned because the specified data source does not exist.
400 Invalid.Tenant.ProjectNotExists The project does not exist. The error message returned because the specified workspace does not exist.
400 Invalid.Tenant.UserNotInProject The user is not in the project. The error message returned because the user is not added to the workspace.
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. The error message returned because the user is not the workspace owner or administrator.
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. The error message returned because the user does not belong to the tenant.

For a list of error codes, visit the API Error Center.