Use ListProjectMembers to query workspace members - DataWorks - Alibaba Cloud - DataWorks

Queries the list of existing members in a DataWorks workspace.

Operation description

Before you begin: DataWorks is activated, the invoking account has the access permissions to the target workspace, and the RAM permissions required to invoke OpenAPI operations are configured.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListProjectMembers

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace.	27
PageNumber	integer	No	The page number. Default value: 1. Minimum value: 1. Maximum value: 30.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	The response structure.
Data	object	The query result.
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
ProjectMemberList	array<object>	The list of members in the workspace.
	array<object>	The member details.
Nick	string	The nickname of the workspace member.	zhangsan
ProjectMemberId	string	The user ID of the member.	121
ProjectMemberName	string	The name of the member.	Zhang San
ProjectMemberType	string	The type of the member. Valid values: 1: Alibaba Cloud account (USER_ALIYUN). 5: RAM user (USER_UBACCOUNT). 6: RAM role (USER_STS_ROLE).	1
ProjectRoleList	array<object>	The list of roles assigned to the member.
	object	The response structure.
ProjectRoleCode	string	The role code. DataWorks provides preset roles. You can also create custom roles based on your business requirements. For more information about roles, see Overview of users, roles, and permissions.	role_project_guest
ProjectRoleId	integer	The role ID.	1
ProjectRoleName	string	The role name. DataWorks provides preset roles. You can also create custom roles based on your business requirements. For more information about roles, see Overview of users, roles, and permissions.	Visitor
ProjectRoleType	string	The type of the role. Valid values: SYSTEM (0): System role. USER_CUSTOM (2): Custom role.	0
Status	string	The status. Valid values: 0: Normal (NORMAL). 1: Disabled (FORBIDDEN). 2: Deleted (DELETED).	0
TotalCount	integer	The total number of entries.	3
RequestId	string	The request ID.	1AFAE64E-D1BE-432B-A9****

Examples

Success response

JSON format

{
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "ProjectMemberList": [
      {
        "Nick": "zhangsan",
        "ProjectMemberId": "121",
        "ProjectMemberName": "Zhang San",
        "ProjectMemberType": "1",
        "ProjectRoleList": [
          {
            "ProjectRoleCode": "role_project_guest",
            "ProjectRoleId": 1,
            "ProjectRoleName": "Visitor",
            "ProjectRoleType": "0"
          }
        ],
        "Status": "0"
      }
    ],
    "TotalCount": 3
  },
  "RequestId": "1AFAE64E-D1BE-432B-A9****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	The project does not exist.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	The user is not in the project.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	The user is not in tenant.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.