文档首页/ AI开发平台ModelArts/ API参考/ 工作空间管理/ 修改工作空间
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

修改工作空间

功能介绍

修改工作空间。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

workspace_id

是

String

工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

grants

否

Array of grants objects

训练作业使用的数据集。不可与data_url或dataset_id/dataset_version_id同时使用。

auth_type

否

String

授权类型。可选值有PUBLIC、PRIVATE、INTERNAL。默认值为PUBLIC。

  • PUBLIC：租户内部公开访问。

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

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

name

否

String

工作空间名称。长度限制为4-64字符，支持中文、大小写字母、数字、中划线和下划线。同时'default'为系统预留的默认工作空间名称，用户无法自己创建名为'default'的工作空间。

description

否

String

工作空间描述，默认为空。长度限制为0-256字符。
表4 grants

参数

是否必选

参数类型

描述

user_id

否

String

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

user_name

否

String

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

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

workspace_id

String

工作空间ID。

请求示例

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

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

响应示例

状态码： 200

修改工作空间成功的响应参数。

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

状态码

状态码

描述

200

修改工作空间成功的响应参数。

错误码

请参见错误码。

父主题： 工作空间管理

相关文档