文档

ListWorkspaces - 查询工作空间列表

更新时间:

查询工作空间列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/workspaces

请求参数

名称类型必填描述示例值
nextTokenstring

用来标记当前开始读取的位置,置空表示从头开始

beb1eff55bf03a13cf321a395dxxxxxx
maxResultsinteger

本次读取的最大数据记录数量,默认 10,最大 100

10
statusListarray

工作空间状态列表

string

工作空间状态。 枚举值:

  • CREATING:创建中
  • SUCCESS:运行中
  • FROZEN:冻结中
  • RECOVERING:恢复中
SUCCESS
workspaceTemplateListarray

技术栈列表

string

技术栈。 枚举值:

  • allinone:通用
  • java-projector:Java 11(Beta)
  • node:Node.js
  • python:Python
  • java-theia:Java(Theia)
  • go:Go
  • ruby:Ruby
  • cpp:C/C++
  • rust:Rust
all-in-one

返回参数

名称类型描述示例值
object

Schema of Response

totalCountinteger

TotalCount 本次请求条件下的数据总量,此参数为可选参数,默认可不返回

100
nextTokenstring

表示当前调用返回读取到的位置,空代表数据已经读取完毕

beb1eff55bf03a13cf321a395dxxxxxx
maxResultsinteger

MaxResults 本次请求所返回的最大记录条数

10
workspacesarray<object>

工作空间列表

object
codeVersionstring

代码版本,支持 commitSHA、分支、标签

master
codeUrlstring

代码来源 URL

https://codeup.aliyun.com/demo/group/Codeup-Demo.git
namestring

工作空间名称

Demo
specstring

机器规格

2::4::60
statusstring

空间状态,枚举:CREATING-创建中, SUCCESS-运行中, FROZEN-冻结中, RECOVERING-恢复中

SUCCESS
templatestring

工作空间模板

all-in-one
idstring

工作空间唯一标识,字符串形式,可在云效 DevStudio 访问空间链接中获取

6ed82817-ab75-4563-865d-81e60dxxxxxx
userIdstring

用户阿里云 PK

1470227819xxxxxx
createTimestring

创建时间戳

1628564442000
requestIdstring

请求 ID

F7B85D1B-D1C2-140F-A039-341859F130B9
successboolean

请求是否成功

true
errorCodestring

错误码

""
errorMessagestring

错误信息

""

示例

正常返回示例

JSON格式

{
  "totalCount": 100,
  "nextToken": "beb1eff55bf03a13cf321a395dxxxxxx",
  "maxResults": 10,
  "workspaces": [
    {
      "codeVersion": "master",
      "codeUrl": "https://codeup.aliyun.com/demo/group/Codeup-Demo.git",
      "name": "Demo",
      "spec": "2::4::60",
      "status": "SUCCESS",
      "template": "all-in-one",
      "id": "6ed82817-ab75-4563-865d-81e60dxxxxxx",
      "userId": "1470227819xxxxxx",
      "createTime": "1628564442000"
    }
  ],
  "requestId": "F7B85D1B-D1C2-140F-A039-341859F130B9",
  "success": true,
  "errorCode": "\"\"",
  "errorMessage": "\"\""
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史