ListProjectMembers - DataWorks - Alibaba Cloud Documentation Center

Queries details about members in a workspace.

Operation description

This API operation is available for all DataWorks editions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:ListProjectMembers	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	62136
UserIds	array	No	The IDs of the accounts used by the members in the workspace. You can log on to the DataWorks console, choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the IDs of the accounts used by the members in the workspace.
	string	No	The ID of the account used by a member in the workspace.	123422344899
RoleCodes	array	No	The codes of the roles in the workspace. You can call the ListProjectRoles operation to query the codes of all roles in the workspace.
	string	No	The ID of a role in the workspace.	role_project_guest
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	9FBBBB1F-DD5E-5D8E-8F50-37F77460F056
PagingInfo	object	The pagination information.
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	12
ProjectMembers	array<object>	The members in the workspace.
ProjectMember	object	The details about a member in the workspace.
ProjectId	long	The ID of the DataWorks workspace.	62136
UserId	string	The ID of the account used by the member.	123422344899
Status	string	The status of the member. Valid values: Normal Forbidden	Normal
Roles	array<object>	The roles that are assigned to the member.
ProjectRole	object	The details about a role that is assigned to the member.
Code	string	The code of the role.	role_project_guest
Name	string	The name of the role.
Type	string	The type of the role. Valid values: UserCustom: custom role System: built-in role	System

Examples

Sample success responses

JSONformat

{
  "RequestId": "9FBBBB1F-DD5E-5D8E-8F50-37F77460F056",
  "PagingInfo": {
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 12,
    "ProjectMembers": [
      {
        "ProjectId": 62136,
        "UserId": "123422344899",
        "Status": "Normal",
        "Roles": [
          {
            "Code": "role_project_guest",
            "Name": "",
            "Type": "System"
          }
        ]
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history