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

查询工作空间列表

功能介绍

查询工作空间列表，响应消息体中包含详细信息。

调试

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

URI

GET /v1/{project_id}/workspaces

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID。获取方法请参见获取项目ID和名称。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

分页列表的起始页，默认为'0'。

limit

否

Integer

指定每一页返回的最大条目数，默认为'1000'。

sort_by

否

String

指定排序字段，可选'name'、'update_time'、'status'，默认是'name'。

order

否

String

可选值。'asc'为递增排序。'desc'为递减排序，默认为'desc'。

enterprise_project_id

否

String

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

name

否

String

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

filter_accessible

否

Boolean

该参数用于筛选可访问的工作空间。指定该参数为true，则会筛选掉当前用户无权限访问的工作空间。该参数默认为false，即为显示所有工作空间。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

工作空间的总数。

count

Integer

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

workspaces

Array of WorkspaceResponse objects

workspace属性列表。
表5 WorkspaceResponse

参数

参数类型

描述

owner

String

创建者名称。

auth_type

String

授权类型。默认值为PUBLIC。

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

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

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

enterprise_project_id

String

企业项目ID。

update_time

Integer

最后修改时间，UTC。

create_time

Integer

创建时间，UTC。

enterprise_project_name

String

企业项目名称。

name

String

工作空间名称。

description

String

工作空间描述。

id

String

工作空间ID，系统生成的32位UUID，不带橫线。默认的工作空间id为'0'。

status

String

工作空间状态。

  • CREATE_FAILED：创建失败。

  • NORMAL：状态正常。

  • DELETING：正在删除。

  • DELETE_FAILED：删除失败。

status_info

String

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

状态码： 400

表6 响应Body参数

参数

参数类型

描述

-

String

状态码： 403

表7 响应Body参数

参数

参数类型

描述

-

String

状态码： 500

表8 响应Body参数

参数

参数类型

描述

-

String

请求示例

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

响应示例

状态码： 200

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

{
  "total_count" : 10,
  "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

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

400

BadRequest

403

Forbidden

500

InternalServerError

错误码

请参见错误码。

父主题： 工作空间管理

相关文档