文档首页/ AI开发平台ModelArts/ API参考/ 工作空间管理/ 查询工作空间列表
更新时间：2025-08-19 GMT+08:00
查看PDF
分享

查询工作空间列表

功能介绍

查询工作空间列表接口用于获取所有已创建的工作空间的详细信息。该接口适用于以下场景：当需要查看所有可用的工作空间或进行审计时，用户可通过此接口查询工作空间列表。使用该接口的前提条件是用户具有查看权限。查询操作完成后，系统将返回所有工作空间的详细信息，包括名称、创建时间、状态等。若用户无权限操作，接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/workspaces

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：用户项目ID。获取方法请参见获取项目ID和名称。

约束限制：1 - 64字符，字母、数字和中划线。

取值范围：不涉及。

默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

分页列表的起始页。

约束限制：

不涉及。

取值范围：

必须为大于等于0，小于等于2147483647。

默认取值：

0。

limit

否

Integer

参数解释：

指定每一页返回的最大条目数。

约束限制：

不涉及。

取值范围：

必须为大于等于1，小于等于1000。

默认取值：

1000。

sort_by

否

String

参数解释：

指定排序字段。

约束限制：

不涉及。

取值范围：

  • name：工作空间名称。

  • update_time：最后修改时间，UTC。

  • status：工作空间状态。

默认取值：

name。

order

否

String

参数解释：

指定排序方式。

约束限制：

不涉及。

取值范围：

  • asc：递增排序。

  • desc：递减排序。

默认取值：

desc。

enterprise_project_id

否

String

参数解释：

企业项目id，指定此参数会只返回该企业项目id下的工作空间。默认显示所有工作空间。

约束限制：

不涉及。

取值范围：

由字母、数字、中划线（-）组成，长度范围36位。

默认取值：

不涉及。

name

否

String

参数解释：

工作空间名称查询参数，指定此参数会模糊查询该名称的工作空间。默认显示所有工作空间。

约束限制：

不涉及。

取值范围：

由中文、英文字符、数字、中划线（-）、下划线（_）组成，长度范围1-64位。

默认取值：

不涉及。

filter_accessible

否

Boolean

参数解释：

筛选可访问的工作空间。

约束限制：

不涉及。

取值范围：

  • false：显示所有工作空间。

  • true：筛选当前用户无权限访问的工作空间。

默认取值：

false。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：

工作空间的总数。

取值范围：

不涉及。

count

Integer

参数解释：

此次请求返回的工作空间个数。

取值范围：

大于等于0，小于等于请求参数的limit值。

workspaces

Array of WorkspaceResponse objects

参数解释：

workspace属性列表。
表5 WorkspaceResponse

参数

参数类型

描述

owner

String

参数解释：

创建者名称。

取值范围：

长度限制为4-64字符，支持中文、大小写字母、数字、中划线和下划线。

auth_type

String

参数解释：

授权类型。

取值范围：

  • PUBLIC：租户内部公开访问。

  • PRIVATE：仅创建者和主账号可访问。

  • INTERNAL：创建者、主账号、指定IAM子账号可访问，需要与grants参数配合使用。

enterprise_project_id

String

参数解释：

企业项目ID。

取值范围：

启用状态的企业项目ID。长度为36位，支持英文字母大小写，数字和中划线（-）。

update_time

Integer

参数解释：

最后修改时间，UTC。

取值范围：

不涉及。

create_time

Integer

参数解释：

创建时间，UTC。

取值范围：

不涉及。

enterprise_project_name

String

参数解释：

企业项目名称。

取值范围：

响应参数enterprise_project_id对应的企业项目名称。

name

String

参数解释：

工作空间名称。

取值范围：

长度限制为4-64字符，支持中文、大小写字母、数字、中划线和下划线。

description

String

参数解释：

工作空间描述。

取值范围：

长度限制为0-256字符，不得包含<、>、=、&、"、'、/特殊字符。

id

String

参数解释：

工作空间ID。获取方法请参见查询工作空间列表。

取值范围：

32位UUID，不带横线。默认的工作空间id为'0'。

status

String

参数解释：

工作空间状态。

取值范围：

  • CREATE_FAILED：创建失败。

  • NORMAL：状态正常。

  • DELETING：正在删除。

  • DELETE_FAILED：删除失败。

status_info

String

参数解释：

状态描述，默认为空。该字段会补充显示状态的详细信息。如删除失败时，可通过该字段查看删除失败的原因。

取值范围：

不涉及。

请求示例

筛选企业项目ID为0的记录，按照name降序排序，分页获取第四页的一条数据

GET https://{endpoint}/v1/{project_id}/workspaces?limit=1&offset=3&sort_by=name&order=desc&enterprise_project_id=0

响应示例

状态码：200

查询工作空间列表成功的响应参数。

{
  "total_count" : 1,
  "count" : 1,
  "workspaces" : [ {
    "id" : 0,
    "name" : "default",
    "description" : "",
    "owner" : "testUser",
    "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***",
    "enterprise_project_name" : "default",
    "auth_type" : "public",
    "create_time" : 1460000010000,
    "update_time" : 1460000010000,
    "status" : "NORMAL",
    "status_info" : ""
  } ]
}

状态码

状态码

描述

200

查询工作空间列表成功的响应参数。

错误码

请参见错误码。

父主题： 工作空间管理