ListProjectMembers - DataWorks - Alibaba Cloud Documentation Center

Queries a list of existing members in a DataWorks workspace.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	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 parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AFAE64E-D1BE-432B-A9****
Data	object	The returned results.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	3
ProjectMemberList	array<object>	The information about members in the DataWorks workspace.
ProjectMember	object
Status	string	The status of the member. Valid values: 0: NORMAL, which indicates that the member is in a normal state. 1: FORBIDDEN, which indicates that the member is disabled. 2: DELETED, which indicates that 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.	zhangsan
ProjectMemberType	string	The type of the member. Valid values: 1: USER_ALIYUN, which indicates that the member is an Alibaba Cloud account. 5: USER_UBACCOUNT, which indicates that the member is a RAM user. 6: USER_STS_ROLE, which indicates that the member is a RAM role.	1
ProjectRoleList	array<object>	The roles that are assigned to the member.
Role	object
ProjectRoleId	integer	The role ID.	1
ProjectRoleType	string	The type of the role. Valid values: 0: SYSTEM, which indicates that the role is a built-in role. 2: USER_CUSTOM, which indicates that the role is a custom role.	0
ProjectRoleName	string	The name of the role. DataWorks provides built-in roles and allows you to create custom roles based on your business requirements. For more information about roles, see Overview of users, roles, and permissions.	test
ProjectRoleCode	string	The code of the role. DataWorks provides built-in roles and allows you to create custom roles based on your business requirements. For more information about roles, see Overview of users, roles, and permissions.	role_project_guest

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation

No change history