ListProjectMembers-DataWorks(DataWorks)-阿里云帮助中心

Queries the members of a DataWorks workspace.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace.	27
PageNumber	integer	No	The page number. Valid values: 1 to 30. Default value: 1.	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 parameters.
RequestId	string	The request ID.	1AFAE64E-D1BE-432B-A9****
Data	object	The query results.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	3
ProjectMemberList	array<object>	The workspace members.
	array<object>
Status	string	The status of the member. Valid values: 0: NORMAL. The member is in a normal state. 1: FORBIDDEN. The member is disabled. 2: DELETED. The member is deleted.	0
ProjectMemberId	string	The member ID.	121
Nick	string	The nickname of the member.	zhangsan
ProjectMemberName	string	The name of the member.	John
ProjectMemberType	string	The type of the member. Valid values: 1: USER_ALIYUN. The member is an Alibaba Cloud account. 5: USER_UBACCOUNT. The member is a RAM user. 6: USER_STS_ROLE. The member is a RAM role.	1
ProjectRoleList	array<object>	The roles assigned to the member.
	object
ProjectRoleId	integer	The role ID.	1
ProjectRoleType	string	The type of the role. Valid values: 0: SYSTEM. The role is built-in. 2: USER_CUSTOM. The role is custom.	0
ProjectRoleName	string	The role name. DataWorks provides built-in roles and supports custom roles. For more information, see Overview of users, roles, and permissions.	Visitor
ProjectRoleCode	string	The role code. DataWorks provides built-in roles and supports custom roles. For more information, see Overview of users, roles, and permissions.	role_project_guest

Examples

Success response

JSON format

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 3,
    "ProjectMemberList": [
      {
        "Status": "0",
        "ProjectMemberId": "121",
        "Nick": "zhangsan",
        "ProjectMemberName": "John",
        "ProjectMemberType": "1",
        "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 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.