文档首页> 云地图服务 KooMap> API参考> API> 工作共享空间> 更新工作共享空间
更新时间：2024-05-17 GMT+08:00
查看PDF
分享

更新工作共享空间

功能介绍

该接口用于工作共享空间信息的更新。可以更新的内容包括：

  • 工作共享空间名称。

  • 工作共享空间描述。

  • 工作共享空间是否置顶显示（不超过4个工作空间）。

调试

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

URI

PUT /v1/workspaces/{workspace_id}

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

工作共享空间ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

IAM Token信息，用于租户鉴权，该字段由租户请求IAM的Token接口获得。
表3 请求Body参数

参数

是否必选

参数类型

描述

workspace_name

否

String

工作共享空间名称。支持中文、英文、数字以及“_”字符，长度限制2~50个字符。

workspace_description

否

String

工作共享空间描述。支持中文、英文、数字以及“_”字符，长度限制200个字符以内。

star

否

Integer

工作共享空间是否置顶显示（最多可置顶4个）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

workspace_id

String

工作共享空间ID。

workspace_name

String

工作共享空间名称。

workspace_description

String

工作共享空间描述。

tenant_domain_id

String

华为云IAM租户账号ID。

creator

String

创建人。

latest_operator

String

最近修改人。

create_time

String

创建时间。返回UTC时间格式字符串，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。

update_time

String

更新时间。返回UTC时间格式字符串，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。

star

Integer

工作共享空间是否置顶显示（最多可置顶4个）。

can_delete

Boolean

工作共享空间是否允许删除标志位。当工作共享空间置顶显示或者该空间下存在任务时，取值为“true”，表示不可以删除。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。格式为：KMP.XXXXXXXX，其中X表示数字。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。格式为：KMP.XXXXXXXX，其中X表示数字。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：2

最大长度：512

请求示例

该请求更新工作共享空间的名称和描述。

POST https://{Endpoint}/v1/workspaces/44eb5d869258451595f15dd26ee0xxxx

{
  "workspace_name" : "测试空间2",
  "workspace_description" : "测试空间描述"
}

响应示例

状态码： 200

请求成功。

{
  "workspace_id" : "44eb5d869258451595f15dd26ee0xxxx",
  "workspace_name" : "测试空间2",
  "workspace_description" : "测试空间描述",
  "tenant_domain_id" : "xxxx",
  "creator" : "xxxx",
  "latest_operator" : "xxxx",
  "create_time" : "2023-05-26T07:30:10Z",
  "update_time" : "2023-05-26T07:34:27Z",
  "star" : 1,
  "can_delete" : false
}

状态码

状态码

描述

200

请求成功。

400

非法请求。

500

服务内部错误。

错误码

请参见错误码。

父主题： 工作共享空间
分享：

    相关文档

    相关产品