更新时间:2025-06-24 GMT+08:00

查询工作空间详情

功能介绍

查询工作空间名称、描述等详情信息

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/workspaces/{workspace_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id

workspace_id

String

工作空间ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

content-type

String

application/json;charset=UTF-8

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

workspace

workspace object

空间详情

表4 workspace

参数

参数类型

描述

id

String

工作空间id

create_time

String

创建时间

update_time

String

更新时间

name

String

工作空间名称

description

String

工作空间描述

creator_id

String

创建人id

creator_name

String

创建人名称

modifier_id

String

修改人id

modifier_name

String

修改人名称

project_id

String

所属项目id

project_name

String

所属项目名称

domain_id

String

所属租户id

domain_name

String

所属租户名称

enterprise_project_id

String

企业项目id

enterprise_project_name

String

企业项目名称

is_view

Boolean

是否是视图

region_id

String

区域id

view_bind_id

String

视图绑定的空间id

view_bind_name

String

视图绑定的空间名称

workspace_agency_list

Array of workspace_agency_list objects

纳管空间列表

表5 workspace_agency_list

参数

参数类型

描述

project_id

String

委托空间所属项目id

id

String

空间委托id

name

String

空间委托名称

region_id

String

委托空间所属region id

workspace_attribution

String

THIS_ACCOUNT:本账号空间,CROSS_ACCOUNT:跨账号空间

agency_version

String

委托版本

domain_id

String

委托租户id

domain_name

String

委托租户名称

iam_agency_id

String

iam委托id

iam_agency_name

String

iam委托名称

resource_spec_code

Array of strings

委托空间购买版本

selected

Boolean

是否被视图选中

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

Error code.

error_msg

String

Error description.

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

Error code.

error_msg

String

Error description.

请求示例

响应示例

状态码:200

请求成功

{
  "workspace" : {
    "create_time" : "2024-07-02T09:25:17Z+0800",
    "creator_id" : "b4*****************************46a",
    "creator_name" : "l0******",
    "description" : "我的工作空间",
    "domain_id" : "ac*****************************bf4",
    "domain_name" : "scc****09",
    "enterprise_project_id" : "",
    "enterprise_project_name" : "",
    "id" : "39*************bf",
    "is_view" : false,
    "modifier_id" : "",
    "modifier_name" : "",
    "name" : "我的工作空间",
    "project_id" : "15**************************da6",
    "project_name" : "project_name",
    "region_id" : "region_id",
    "update_time" : "2024-07-02T09:25:17Z+0800",
    "view_bind_id" : "",
    "view_bind_name" : "",
    "workspace_agency_list" : [ ]
  }
}

状态码

状态码

描述

200

请求成功

400

请求参数有误

500

请求失败

错误码

请参见错误码