QueryWorkspaceUserList - Quick BI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query the list of members under a specified 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

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
quickbi-public:QueryWorkspaceUserList	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****
Keyword	string	No	Keyword for the username of the workspace member.	test
PageNum	integer	No	Current page number of the workspace member list: Starting value: 1 Default value: 1	1
PageSize	integer	No	Number of rows per page in a paginated query: Default value: 10 Maximum value: 1000	10

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Possible values: true: The request was successful. false: The request failed.	true
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Returns the paginated result of the member list, with detailed information about the members stored in the Data parameter of the response.
Data	array<object>	Information about the workspace members.
Data	object
AccountId	string	Alibaba Cloud account ID.	16020915****8429
AccountName	string	Alibaba Cloud account name.	pop****@aliyunid.test
NickName	string	Nickname.	test
Role	object	Preset role information for the workspace member.
RoleCode	string	Code corresponding to the preset role.	role_workspace_admin
RoleId	long	Preset role ID. Possible values: 25: Workspace Administrator 26: Workspace Developer 27: Workspace Analyst 30: Workspace Viewer	25
RoleName	string	Name of the preset role.	test
UserId	string	Quick BI user ID.	de4bc5f9429141cc8091cdd1c15b****
PageNum	integer	Page number.	1
PageSize	integer	Number of rows per page as set in the request.	10
TotalNum	integer	Total number of rows.	1
TotalPages	integer	Total number of pages.	1

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AccountId": "16020915****8429",
        "AccountName": "pop****@aliyunid.test",
        "NickName": "test",
        "Role": {
          "RoleCode": "role_workspace_admin",
          "RoleId": 25,
          "RoleName": "test"
        },
        "UserId": "de4bc5f9429141cc8091cdd1c15b****"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.
400	Workspace.Not.Exist	The group workspace does not exist.	The group workspace does not exist.

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