全部产品
Search

搜索本产品

    数据管理 DMS：ListWorkspaces - 获取工作空间列表

    文档中心

    数据管理 DMS：ListWorkspaces - 获取工作空间列表

    更新时间：Aug 28, 2026

    该接口用于获取租户下的工作空间列表。

    调试

    您可以在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

    integer

    否

    服务账号 ID

    12345
    WorkspaceId

    integer

    否

    工作空间的 ID。

    12****
    PageNumber

    integer

    否

    页码。

    1
    PageSize

    integer

    否

    每页的返回结果个数。

    10
    VpcId

    string

    否

    专有网络 VPC 的 ID。

    说明

    暂时无法用作过滤。

    vpc-bp10wnlcmor****

    返回参数

    名称

    类型

    描述

    示例值

    object

    RequestId

    string

    请求 ID。

    EE214ECD-4330-503A-82F0-FFB03975****
    ErrorCode

    string

    错误码。

    UserNotExist
    ErrorMessage

    string

    调用失败时，返回的错误信息。

    UnknownError
    Success

    boolean

    请求是否成功。返回值如下：

    • true：请求成功。

    • false：请求失败。

    true
    TotalCount

    integer

    满足条件的工作空间总个数。

    10
    Data

    object

    BaseWorkspaces

    array<object>

    数据集。

    object

    Description

    string

    工作空间的描述。

    Test
    CreatorId

    integer

    创建人的 ID。

    123
    OwnerUid

    string

    责任人的阿里云 UID。

    15608564799****
    WorkspaceId

    integer

    工作空间的 ID。

    8652340494****
    GmtModified

    string

    更新时间。

    2025-01-01 00:00:00
    ServiceAccountId

    integer

    服务账号 ID。

    12345
    CreatorUid

    string

    创建者的阿里云 UID。

    1344****
    ServiceAccountNickName

    string

    服务账号的昵称。

    testname
    Name

    string

    工作空间的名称。

    workspace-xxxx
    AlreadyJoined

    boolean

    当前用户是否已加入工作空间。

    true
    TenantId

    integer

    项目空间所在的租户 ID。

    23456
    GmtCreate

    string

    创建时间。

    2025-01-01 00:00:00
    ServiceAccountUid

    string

    服务账号的阿里云 UID。

    1422****
    OwnerId

    integer

    负责人的 ID。

    123****
    VpcId

    string

    专有网络 VPC 的 ID。

    vpc-25fl3qjqb****
    Region

    string

    地域信息。

    cn-hangzhou
    WorkspaceName

    string

    工作空间的名称。

    test-workspace
    CreatorNickName

    string

    创建人的昵称。

    work*****
    OwnerNickName

    string

    Owner 昵称。

    hel****
    NextToken

    string

    NextToken 暂无用途。

    token-xxx
    MaxResults

    integer

    与 TotalCount 相同，满足条件的工作空间总个数。

    10

    示例

    正常返回示例

    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
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。