更新时间:2022-09-26 GMT+08:00
分享

修改工作空间

功能介绍

修改工作空间。

调试

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

URI

PUT /v1/{project_id}/workspaces/{workspace_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户项目ID。获取方法请参见获取项目ID和名称

workspace_id

String

工作空间ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

工作空间名称,utf8。

长度限制为4-64字符,支持中文、大小写字母、数字、中划线和下划线。由于“default”为系统预留的默认工作空间名称,用户无法修改已有的工作空间名称为“default”。同时默认工作空间不支持修改名称。

description

String

工作空间描述,默认为空。长度限制为0-256字符。

auth_type

String

授权类型。可选值有:

  • PUBLIC:租户内部公开访问。(默认值)

  • PRIVATE:仅创建者和主账号可访问。

  • INTERNAL:创建者、主账号、指定IAM子账号可访问,需要与grants参数配合使用。

grants

Array of grants objects

授权用户列表,默认为空。需要与“auth_type”参数配合使用,且仅当授权类型为“INTERNAL”时才会生效。

表3 grants

参数

是否必选

参数类型

描述

user_id

String

用户ID,此参数与user_name必填一个。两者都填优先使用user_id。

user_name

String

IAM用户名称。此参数与user_id必填一个。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

workspace_id

String

工作空间ID,系统生成的32位UUID,不带橫线。默认的工作空间ID为“0”。

请求示例

修改工作空间

PUT  https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}

{
  "name" : "my_workspace",
  "description" : "It is my workspace",
  "auth_type" : "INTERNAL",
  "grants" : [ {
    "user_name" : "my_iam_user"
  } ]
}

响应示例

状态码: 200

OK

{
  "workspace_id" : "***05d1a553b4e188ea878e7dcb85***"
}

状态码

状态码

描述

200

OK

400

BadRequest

403

Forbidden

500

InternalServerError

错误码

请参见错误码

分享:

    相关文档

    相关产品

close