All Products
Search
Document Center

DataWorks:ListProjectMembers

Last Updated:Dec 20, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:ListProjectMembersget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

The ID of the DataWorks workspace.

27
PageNumberintegerNo

The page number. Valid values: 1 to 30. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1AFAE64E-D1BE-432B-A9****
Dataobject

The returned results.

PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The total number of entries returned.

3
ProjectMemberListarray<object>

The information about members in the DataWorks workspace.

ProjectMemberobject
Statusstring

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
ProjectMemberIdstring

The member ID.

121
Nickstring

The nickname of the member.

zhangsan
ProjectMemberNamestring

The name of the member.

zhangsan
ProjectMemberTypestring

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
ProjectRoleListarray<object>

The roles that are assigned to the member.

Roleobject
ProjectRoleIdinteger

The role ID.

1
ProjectRoleTypestring

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
ProjectRoleNamestring

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
ProjectRoleCodestring

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 codeError codeError messageDescription
400Invalid.Tenant.ConnectionNotExistsThe connection does not exist.The connection does not exist.
400Invalid.Tenant.ProjectNotExistsThe project does not exist.The project does not exist.
400Invalid.Tenant.UserNotInProjectThe user is not in the project.The user is not in the project.
403Invalid.Tenant.UserIsNotProjectOwnerOrAdminThe user is not a project administrator or owner.The user is not a project administrator or owner.
403Invalid.Tenant.UserNotInTenantThe 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 timeSummary of changesOperation
No change history