# 修改工作空间 - UpdateWorkspace #### 功能介绍 修改工作空间接口用于更新指定工作空间的配置信息。 该接口适用于以下场景：当用户需要更改工作空间的名称、描述或其他配置信息时，可以通过此接口进行修改。使用该接口的前提条件是工作空间已存在且用户具有修改该工作空间的权限。修改操作完成后，接口将返回更新后的工作空间详细信息，包括但不限于工作空间名称、描述、更新时间等。若工作空间不存在或用户无权限操作，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=UpdateWorkspace)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:workspace:update | Write | workspace \* | - | - | - | #### URI PUT /v1/{project_id}/workspaces/{workspace_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | workspace_id | 是 | String | **参数解释** ：工作空间ID。获取方法请参见[查询工作空间列表](https://support.huaweicloud.com/api-modelarts/ListWorkspace.html#ZH-CN_TOPIC_0000002723741766)。未创建工作空间时默认值为"0"，存在创建并使用的工作空间，以实际取值为准。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | grants | 否 | Array of [grants] objects | **参数解释**：授权用户列表。 **约束限制**：当且仅当"auth_type"的值为"INTERNAL"时才会生效，长度不超过500。 | | auth_type | 否 | String | **参数解释**：授权类型。 **约束限制**：不涉及。 **取值范围**：可选值有： - PUBLIC：租户内部公开访问。 - PRIVATE：仅创建者和主账号可访问。 - INTERNAL：创建者、主账号、指定IAM子账号可访问，需要与grants参数配合使用。 **默认取值**：默认值为PUBLIC。 | | name | 否 | String | **参数解释** ：工作空间名称。**约束限制** ：长度限制为4-64字符，支持中文、大小写字母、数字、中划线和下划线。同时'default'为系统预留的默认工作空间名称，用户无法自己创建名为'default'的工作空间。**取值范围** ：不涉及。**默认取值**：不涉及。 | | description | 否 | String | **参数解释**：工作空间描述。 **约束限制**：长度限制为0-256字符。 **取值范围**：不涉及。 **默认取值**：默认为空。 | 表4grants | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | user_id | 否 | String | **参数解释**：用户ID。 **约束限制**：user_type为IAM用户时，与user_name任填其一，推荐填user_id。委托用户时必填。联邦用户时忽略该字段，响应自动生成。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | user_name | 否 | String | **参数解释**：用户名称。 **约束限制**：user_type为IAM用户时，与user_id任填其一，推荐填user_id，委托用户及联邦用户时必填。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | user_type | 否 | String | **参数解释**： 授权用户类型。 **约束限制**： 如果是联邦用户或者委托用户的话必填。 **取值范围**： IAM:IAM用户, FEDERATE：联邦用户, AGENCY：委托用户。 **默认取值**： IAM。 | #### 响应参数 **状态码：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 | 修改工作空间成功的响应参数。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。