文档首页/智能数据洞察 DataArts Insight/API参考/工作空间/修改工作空间 - UpdateWorkspace
更新时间：2025-11-25 GMT+08:00
查看PDF
分享

修改工作空间 - UpdateWorkspace

功能介绍

修改工作空间。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释：

工作空间ID。获取方法请参见获取工作空间ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

configs

否

Map<String,String>

参数解释：

工作空间的configs配置的属性值。

取值范围：

  • default_dataset_permission值为“1”时，未开启行级权限时可查看数据集所有数据

  • default_dataset_permission值为“0”时，未开启行级权限时查看数据集数据为空

name

是

String

参数解释：

工作空间名称。

取值范围：

[0,1024]

description

否

String

参数解释：

工作空间描述。

取值范围：

[0,10240]

eps_id

是

String

参数解释：

工作空间所属企业项目ID。

取值范围：

[0,128]

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释：

工作空间id。

取值范围：

[0,128]

请求示例

修改工作空间。

/v1/{project_id}/instances/{instance_id}/workspaces/xxxxaaa59ce841f8b4cc2c1305c1xxxx

{
  "configs" : {
    "mode" : "0",
    "field_show_type" : "0",
    "only_admin_create_datasource" : "0",
    "works_authorized" : "0",
    "works_public" : "1",
    "works_view" : "0"
  },
  "name" : "测试name",
  "description" : "这是一段测试描述",
  "eps_id" : "0"
}

响应示例

状态码：200

OK

{
  "id" : "xxxxaaa59ce841f8b4cc2c1305c1xxxx"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：工作空间

相关文档