Query workspaces ## Request description For low latency, select the service address that corresponds to the Region where your resources are located. For details, see [Service addresses](https://www.volcengine.com/docs/6461/1802289). * Request method: POST * Request URL: https://cp.cn\-beijing.volcengineapi.com?Action=ListWorkspaces&Version=2023\-05\-01 ## Request parameters |**Parameter** |**Type** |**Required** |**Sample Value** |**Description** | |---|---|---|---|---| |Action |String |Yes |ListWorkspaces |The API name. The name of the current API is `ListWorkspaces`. | |Version |String |Yes |2023\-05\-01 |The API version. The current version of the API is `2023-05-01`. | |PageNumber |Long |no |1 |The starting page number when querying. The default number is 1. | |PageSize |Long |no |10 |The number of results per page:

* Minimum value: 1

* Maximum value: 100

* Default value: 10 | |Filter |Object of [WorkspaceFilter](https://www.volcengine.com/docs/6461/1278087#workspacefilter) |no |\- |Filter criteria for the workspace being queried. | ### WorkspaceFilter |**Parameter** |**Type** |**Required** |**Sample Value** |**Description** | |---|---|---|---|---| |Name |String |no |work |Filter workspace names using fuzzy search. | |Ids |Array of String |no |["2c7a85e4ac034eb790b096705694\*\*\*\*"] |Filter by workspace ID to perform an exact search. | ## Sample requests ```json POST https://cp.cn-beijing.volcengineapi.com?Action=ListWorkspaces&Version=2023-05-01 HTTP/1.1 Content-Type: application/json { "PageNumber": 1, "PageSize": 10, "Filter": { "Name": "work", "Ids": [ "2c7a85e4ac034eb790b096705694****" ] } } ``` ## Response parameters |**Parameter** |**Type** |**Sample Value** |**Description** | |---|---|---|---| |TotalCount |Long |20 |Total number of workspaces. | |Items |Array of [Workspace](https://www.volcengine.com/docs/6461/1278087#workspace) |\- |Workspace list. | |PageNumber |Long |1 |The current page number. | |PageSize |Long |10 |Number of single pages. | ### Workspace |**Parameter** |**Type** |**Sample Value** |**Description** | |---|---|---|---| |Id |String |18be9d623fba45a1aca409f5e19c\*\*\*\* |Workspace ID. | |Name |String |workspace\-test |The workspace name. | |Description |String |A description |The workspace description. | |Creator |Object of [IAMUser](https://www.volcengine.com/docs/6461/1278087#iamuser) |{

"AccountId": 24506499\*\*\*\*,

"UserId": 0

} |The workspace creator. | |Visibility |String |Specified |Workspace visibility for members

* Account: Visible to all users

* Specified: Visible to designated users | |VisibleUsers |Array of [IAMUser](https://www.volcengine.com/docs/6461/1278087#iamuser) |[

{

"AccountId": 24506499\*\*\*\*,

"UserId": 0

},

{

"AccountId": 24506499\*\*\*\*,

"UserId": 1454\*\*\*

}

] |When the "Visible to members" setting for the workspace is set to "Specified", the list of visible users will then be displayed. | |CreateTime |String |2023\-05\-10T14:11:28+08:00 |Workspace creation time. | |UpdateTime |String |2023\-05\-10T14:11:28+08:00 |The workspace update time. | ### IAMUser |**Parameter** |**Type** |**Sample Value** |**Description** | |---|---|---|---| |AccountId |Long |210048\*\*\*\* |account (main account) ID. | |UserId |Long |28\*\*\*\* |Sub\-user (IAM user) ID. | ## Sample response ```json HTTP/1.1 200 OK Content-Type: application/json { "ResponseMetadata": { "RequestId": "202404031430323BAEA57387980A0B****", "Action": "ListWorkspaces", "Version": "2023-05-01", "Service": "cp", "Region": "cn-beijing", }, "Result": { "TotalCount": 1, "PageNumber": 1, "PageSize": 10, "Items": [ { "Id": "18be9d623fba45a1aca409f5e19c****", "Name": "workspace-test", "CreateTime": "2023-05-10T14:11:28+08:00", "UpdateTime": "2023-05-10T14:11:28+08:00", "Creator": { "AccountId": 24506499****, "UserId": 0 }, "Visiblity": "Specified", "VisibleUsers": [ { "AccountId": 24506499****, "UserId": 0 }, { "AccountId": 24506499****, "UserId": 1454*** } ] } ] } } ``` ## Error code This API does not currently have independent error codes. If an exception is returned when calling the API, you can refer to [public error codes](https://www.volcengine.com/docs/6461/1271177) for troubleshooting.

Code Pipeline