更新时间:2022-05-13 GMT+08:00
分享

更新工作空间

功能介绍

更新工作空间信息, 只允许更新描述信息。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v2.0/{project_id}/workspaces/{workspace_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id,获取方式请参见获取项目ID

workspace_id

String

工作空间id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

内容类型,取值为application/json。

X-Auth-Token

String

用户token,获取方式请参见获取用户Token

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

工作空间名称,1-64位数字、字母、下划线、中划线组成,支持中文,不能以 - 结尾。

最小长度:1

最大长度:64

description

String

描述。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

is_success

Boolean

是否成功。

message

String

返回消息。

error_code

String

错误码(请求成功时,不返回此字段)。

请求示例

修改工作空间的描述

/v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx

{
  "description" : "modify the workspace description",
  "name" : "workspace"
}

响应示例

状态码: 200

OK

{
  "is_success" : true,
  "message" : "Succeed to update workspace. "
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档