ListWorkspaces - Data Management - Alibaba Cloud Documentation Center

Queries a list of workspaces of the tenant.

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
dms:ListWorkspaces	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
AlreadyJoined	boolean	No	Specifies whether the current user has joined the workspace.	true
SearchKey	string	No	The search keyword. Fuzzy match is supported.	poc_test
Region	string	No	The region in which the bucket is located.	cn-hangzhou
ServiceAccountId	long	No	The service account ID.	12345
WorkspaceId	long	No	The workspace ID.	12****
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
VpcId	string	No	The virtual private cloud (VPC) ID. Note This parameter cannot be used as a filter.	vpc-bp10wnlcmor****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	EE214ECD-4330-503A-82F0-FFB03975****
ErrorCode	string	The error code.	UserNotExist
ErrorMessage	string	The error message that is returned if the request failed.	UnknownError
Success	boolean	Indicates whether the call was successful. Valid values: true: The request succeeded. false: The request failed.	true
TotalCount	long	The total number of workspaces that meet the conditions.	10
Data	array<object>	The dataset.
BaseWorkspaces	object
Description	string	The description of the workspace.	Test
CreatorId	long	The ID of the creator.	123
OwnerUid	string	The Alibaba Cloud UID of the owner.	15608564799****
WorkspaceId	long	The workspace ID.	8652340494****
GmtModified	string	The update time.	2025-01-01 00:00:00
ServiceAccountId	long	The ID of the service account.	12345
CreatorUid	string	The Alibaba Cloud account UID of the creator.	1344****
ServiceAccountNickName	string	The nickname of the service account.	testname
Name	string	The name of the workspace.	workspace-xxxx
AlreadyJoined	boolean	Whether the current user has joined the workspace.	true
TenantId	long	The ID of the tenant to which the workspace belongs.	23456
GmtCreate	string	The creation time.	2025-01-01 00:00:00
ServiceAccountUid	string	The Alibaba Cloud account UID of the service account.	1422****
OwnerId	long	The owner ID.	123****
VpcId	string	The VPC ID.	vpc-25fl3qjqb****
Region	string	The region ID.	cn-hangzhou
WorkspaceName	string	The name of the workspace.	test-workspace
CreatorNickName	string	The nickname of the creator.	work*****
OwnerNickName	string	The nickname of the owner.	hel****
NextToken	string	NextToken does not take effect.	token-xxx
MaxResults	integer	The total number of workspaces that meet the condition, which is the same as the TotalCount parameter.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE214ECD-4330-503A-82F0-FFB03975****",
  "ErrorCode": "UserNotExist",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TotalCount": 10,
  "Data": {
    "BaseWorkspaces": [
      {
        "Description": "Test",
        "CreatorId": 123,
        "OwnerUid": "15608564799****",
        "WorkspaceId": 0,
        "GmtModified": "2025-01-01 00:00:00",
        "ServiceAccountId": 12345,
        "CreatorUid": "1344****",
        "ServiceAccountNickName": "testname",
        "Name": "workspace-xxxx",
        "AlreadyJoined": true,
        "TenantId": 23456,
        "GmtCreate": "2025-01-01 00:00:00",
        "ServiceAccountUid": "1422****",
        "OwnerId": 0,
        "VpcId": "vpc-25fl3qjqb****",
        "Region": "cn-hangzhou",
        "WorkspaceName": "test-workspace",
        "CreatorNickName": "work*****",
        "OwnerNickName": "hel****"
      }
    ]
  },
  "NextToken": "token-xxx",
  "MaxResults": 10
}

Error codes

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