更新时间:2023-04-24 GMT+08:00
分享

获取工作空间列表

功能介绍

查询用户名下的所有工作空间信息,并返回列表和总条目数

URI

GET /v3/{project_id}/ai-mgr/workspaces

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

iam_user_id

String

用户的userId,用于查询指定的的子工作空间

offset

Integer

查询的起始位置,取值范围为非负整数,默认为0

limit

Integer

每页显示的条目数量,取值范围1~100,默认为100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户Token。获取方法请参见获取Token

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

返回总条目数

workspaces

Array of WorkspaceListElem objects

工作空间列表

表5 WorkspaceListElem

参数

参数类型

描述

workspace_id

String

工作空间id

ma_workspace_id

String

对应的Modelarts工作空间的id

project_id

String

项目ID

name

String

工作空间名称

description

String

工作空间描述

enterprise_project_id

String

企业项目ID

enterprise_project_name

String

企业项目名称

create_time

Long

创建时间

update_time

Long

更新时间

owner

String

创建者

user_id

String

创建者的USER_ID

used_flag

String

正在被使用

请求示例

查询用户名下的所有工作空间信息

GET https://{endpoint}/v3/{project_id}/ai-mgr/workspaces

Request Header:  Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应示例

状态码: 200

请求成功

{
  "count" : 5,
  "workspaces" : [ {
    "workspace_id" : "0",
    "ma_workspace_id" : null,
    "project_id" : "123",
    "name" : "default",
    "description" : null,
    "enterprise_project_id" : "0",
    "enterprise_project_name" : "default",
    "create_time" : 1598094655508,
    "update_time" : 1598094655508,
    "owner" : "sss",
    "user_id" : "123",
    "used_flag" : null
  } ]
}

状态码

状态码

描述

200

请求成功

401

认证不通过

403

拒绝执行请求

404

请求的资源不存在

500

服务器内部错误

错误码

请参见错误码

相关文档