You can call this operation ListProjectMembers query DataWorks existing members of a 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 Required ListProjectMembers

The operation that you want to perform.

ProjectId Long Yes 27

Dataworks ID of the workspace.

RegionId String Required cn-shanghai

The region ID of the workspace.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 10

The size of each page in a paged query.

Response parameters

Parameter Type Example Description
Data Struct

The returned query results.

PageNumber Integer 1

The current page number.

PageSize Integer 10

The size of each page.

ProjectMemberList Array

The list of members in the workspace.

Nick String zhangsan

The nickname of the member.

ProjectMemberId String 121

User ID of the member.

ProjectMemberName String Zhang San

Name of the member.

ProjectMemberType String 0

Type of member.

ProjectRoleList Array

The list of roles owned by the member.

ProjectRoleCode String role_project_guest

The Code of the role.

ProjectRoleId Integer 1

The ID of the role.

ProjectRoleName String Visitor

The name of the role.

ProjectRoleType String 0

The type of the role.

Status String 0

The status of the production studios to query. Valid values:

TotalCount Integer 3

The total number of entries returned.

RequestId String 1AFAE64E-D1BE-432B-A9****

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListProjectMembers
&ProjectId=27
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<TotalNum>5</TotalNum>
<PageNum>1</PageNum>
<PageSize>10</PageSize>
<RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>
<ProjectMemberList>
    <CreateOn>2020-02-03 19:00:00</CreateOn>
    <Status>0</Status>
    <ProjectMemberType>5</ProjectMemberType>
    <ProjectMemberId>12312312</ProjectMemberId>
    <Nick>tom_xxx</Nick>
    <ProjectMemberName> </ProjectMemberName> Zhang San
</ProjectMemberList>
<ProjectMemberList>
    <ProjectRoleList>
        <ProjectRoleName> visitor </ProjectRoleName>
        <ProjectRoleType>0</ProjectRoleType>
        <ProjectRoleCode>role_project_guest</ProjectRoleCode>
        <ProjectRoleId>1</ProjectRoleId>
    </ProjectRoleList>
</ProjectMemberList>

JSON format

{
    "TotalNum": 5,
    "PageNum": 1,
    "PageSize": 10,
    "RequestId": "1AFAE64E-D1BE-432B-A9****",
    "ProjectMemberList": [
        {
            "CreateOn": "2020-02-03 19:00:00",
            "Status": 0,
            "ProjectMemberType": 5,
            "ProjectMemberId": 12312312,
            "Nick": "tom_xxx",
            "ProjectMemberName": "John"
        },
        {
            "ProjectRoleList": {
                "ProjectRoleName": "Visitor",
                "ProjectRoleType": 0,
                "ProjectRoleCode": "role_project_guest",
                "ProjectRoleId": 1
            }
        }
    ]
}

Error codes

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

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