GetProjectMember - DataWorks - Alibaba Cloud Documentation Center

Queries the details about a member 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:GetProjectMember	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The DataWorks workspace ID. 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.	88757
UserId	string	Yes	The ID of the account used by the member. 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.	123422344899

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.	8abcb91f-d266-4073-b907-2ed670378ed1
ProjectMember	object	The details about the member in the workspace.
ProjectId	long	The DataWorks workspace ID.	88757
UserId	string	The ID of the account used by the member in the workspace.	123422344899
Status	string	The status of the member. Normal Forbidden	Normal
Roles	array<object>	The roles that are assigned to the member in the workspace.
ProjectRole	object	The details about a role that is assigned to the member in the workspace.
Code	string	The code of the role. Valid values: role_project_admin: Workspace Administrator role_project_dev: Develop role_project_dg_admin: Data Governance Administrator role_project_guest: Visitor role_project_security: Security Administrator role_project_deploy: Deploy role_project_owner: Workspace Owner role_project_data_analyst: Data Analyst role_project_pe: O&M role_project_erd: Model Designer	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": "8abcb91f-d266-4073-b907-2ed670378ed1",
  "ProjectMember": {
    "ProjectId": 88757,
    "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