该接口用于获取租户下的工作空间列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dms:ListWorkspaces | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AlreadyJoined | boolean | 否 | 当前用户是否已加入工作空间。 | true |
| SearchKey | string | 否 | 搜索关键词，支持模糊搜索。 | poc_test |
| Region | string | 否 | 地域。 | cn-hangzhou |
| ServiceAccountId | long | 否 | 服务账号 ID | 12345 |
| WorkspaceId | long | 否 | 工作空间的 ID。 | 12**** |
| PageNumber | integer | 否 | 页码。 | 1 |
| PageSize | integer | 否 | 每页的返回结果个数。 | 10 |
| VpcId | string | 否 | 专有网络 VPC 的 ID。 说明
暂时无法用作过滤。
| vpc-bp10wnlcmor**** |
返回参数
示例
正常返回示例
JSON格式
{
"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
}错误码
访问错误中心查看更多错误码。