# 查询工作空间详情 - ShowWorkspace #### 功能介绍 查询工作空间详情接口用于获取指定工作空间的详细信息。 该接口适用于以下场景：当用户需要查看工作空间的具体配置、状态或相关信息时，可以通过此接口获取详细数据。使用该接口的前提条件是工作空间已存在且用户具有查看该工作空间的权限。查询操作完成后，接口将返回工作空间的详细信息，包括但不限于工作空间名称、描述、创建时间、状态等。若工作空间不存在或用户无权限操作，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ShowWorkspace)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:workspace:get | Read | workspace \* | - | - | - | #### URI GET /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的值）。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | grants | Array of [grants] objects | **参数解释**：授权用户列表。默认为空。需要与"auth_type"参数配合使用，且仅当授权类型为"INTERNAL"时才会生效。 | | owner | String | **参数解释**：创建者名称。 **取值范围**：不涉及。 | | auth_type | String | **参数解释**：授权类型。 **取值范围**：可选值有： - PUBLIC：租户内部公开访问。 - PRIVATE：仅创建者和主账号可访问。 - INTERNAL：创建者、主账号、指定IAM子账号可访问，需要与grants参数配合使用。 | | enterprise_project_id | String | **参数解释**：企业项目ID。 **取值范围**：不涉及。 | | update_time | Long | **参数解释**：最后修改时间，UTC，Unix时间戳，单位为毫秒。 **取值范围**：不涉及。 | | create_time | Long | **参数解释**：创建时间，UTC，Unix时间戳，单位为毫秒。 **取值范围**：不涉及。 | | enterprise_project_name | String | **参数解释**：企业项目名称。 **取值范围**：不涉及。 | | name | String | **参数解释**：工作空间名称。长度限制为4-64字符，支持中文、大小写字母、数字、中划线和下划线。同时'default'为系统预留的默认工作空间名称，用户无法自己创建名为'default'的工作空间。 **取值范围**：不涉及。 | | description | String | **参数解释**：工作空间描述。 **取值范围**：不涉及。 | | id | String | **参数解释**：工作空间ID，系统生成的32位UUID，不带横线。 **取值范围**：不涉及。 | | status | String | **参数解释**：工作空间状态。 **取值范围**：枚举值： - CREATE_FAILED：创建失败。 - NORMAL：状态正常。 - DELETING：正在删除。 - DELETE_FAILED：删除失败。 | | status_info | String | **参数解释**：状态描述，默认为空。该字段会补充显示状态的详细信息。如删除失败时，可通过该字段查看删除失败的原因。 **取值范围**：不涉及。 | 表4grants | 参数 | 参数类型 | 描述 | |:---|:---|:---| | user_id | String | **参数解释**：用户ID。此参数与user_name必填一个。两者都填优先使用user_id。 **取值范围**：不涉及。 | | user_name | String | **参数解释**：用户名称。此参数与user_id必填一个。 **取值范围**：不涉及。 | | user_type | String | 参数解释： 授权用户类型，如果是联邦用户或者委托用户的话必填，默认取值为IAM。 取值范围： IAM：IAM用户, FEDERATE：联邦用户, AGENCY：委托用户。 | #### 请求示例 ``` GET https://{endpoint}/v1/{project_id}/workspaces/ccd05d1a553b4e188ea878e7dcb85e47 ``` #### 响应示例 **状态码：200** ``` { "id" : "**d05d1a553b4e188ea878e7dcb85e**", "name" : "test-workspace", "status" : "NORMAL", "status_info" : "", "description" : "", "owner" : "testUser", "create_time" : 1470000020000, "update_time" : 1470000030000, "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", "enterprise_project_name" : "test-eps", "auth_type" : "INTERNAL", "grants" : [ { "user_id" : "***55d2cd53b4x458ea878e7dcb85***", "user_name" : "test-iam-user", "user_type" : "IAM" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询工作空间详情成功的响应参数。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。