调用GetWorkspace查询工作空间详情_云效2020-阿里云帮助中心

查询工作空间基本信息。

调试

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

调试

授权信息

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

请求语法

GET /api/workspaces/{workspaceId}

请求参数

名称	类型	必填	描述	示例值
workspaceId	string	是	工作空间唯一标识，字符串形式，可在云效DevStudio访问空间链接中获取	6ed82817-ab75-4563-865d-81e60dxxxxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
workspace	object	工作空间信息
codeVersion	string	代码版本，支持 commitSHA、分支、标签	master
codeUrl	string	代码来源URL	https://codeup.aliyun.com/demo/group/Codeup-Demo.git
name	string	工作空间名称	Demo
spec	string	机器规格	2::4::60
status	string	空间状态，枚举：CREATING-创建中, SUCCESS-运行中, FROZEN-冻结中, RECOVERING-恢复中	SUCCESS
template	string	工作空间模板	all-in-one
id	string	工作空间唯一标识，字符串形式，可在云效DevStudio访问空间链接中获取	6ed82817-ab75-4563-865d-81e60dxxxxxx
userId	string	用户阿里云PK	1470227819xxxxxx
createTime	string	创建时间戳	1628564442000
success	boolean	请求是否成功	true
errorCode	string	错误码	InvalidWorkspace.NotFound
errorMessage	string	错误信息	The workspace is not found.
requestId	string	请求ID	F7B85D1B-D1C2-140F-A039-341859F130B9

示例

正常返回示例

JSON格式

{
  "workspace": {
    "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"
  },
  "success": true,
  "errorCode": "InvalidWorkspace.NotFound",
  "errorMessage": "The workspace is not found.",
  "requestId": "F7B85D1B-D1C2-140F-A039-341859F130B9"
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden.AccessDenied	The user is not authorized to perform the operation.	用户无权限执行相关操作
404	InvalidWorkspace.NotFound	The workspace is not found.	工作空间不存在

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