文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 工作空间/ 查询工作空间
更新时间：2024-08-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询工作空间

功能介绍

查询工作空间列表。

仅支持查看权限内支持访问的工作空间。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID。

project_id

是

String

项目ID。获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

工作空间名称。支持模糊查询。

取值范围：[0,100]

offset

否

Integer

返回条目的起始offset。

取值范围：[0,2147483647]

默认值：0

limit

否

Integer

返回条目数。不传该参数时，默认查询前10条信息。

取值范围：[0,2147483647]

默认值：10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总条目数。

page_data

Array of objects

当前页的数据，元素类型为WorkspaceVO。详细参数类型请参考WorkspaceVO。
表5 WorkspaceVO

参数

参数类型

描述

configs

Map<String,String>

configs

create_time

Long

工作空间的创建时间。

create_user

String

工作空间的创建者。

description

String

工作空间的描述信息。

domain_id

String

domainId。

eps_id

String

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

id

String

工作空间ID

instance_id

String

实例ID。

is_default

Integer

是否设置为默认空间。

取值：0、1。

name

String

工作空间名称。

owner_name

String

工作空间所有者名称。

project_id

String

工作空间所属的项目ID。

update_time

Long

工作空间的更新时间。

update_user

String

工作空间的更新责任人。

请求示例

查询项目下的工作空间的信息。

/v1/{project_id}/instances/{instance_id}/workspaces?offset=0&limit=10name=

响应示例

{
  "count" : 17,
  "page_data" : [ {
    "configs" : {
                "mode": "0",
                "worksAuthorized": "0",
                "worksPublic": "1",
                "onlyAdminCreateDatasource": "0",
                "isPin": "1",
                "fieldShowType": "0",
                "worksView": "0"
            },
    "create_time" : 1676984980510,
    "create_user" : "xxxxxx",
    "description" : "Description workspace information",
    "domain_id" : "xxxxxxx",
    "eps_id" : "xxxxxxxxxx",
    "id" : "xxxxxxxxxxxxx",
    "instance_id" : "xxxx7d17c41c414dabaa08f47c7dxxxx",
    "is_default" : 1,
    "name" : "Example workspace name",
    "owner_name" : "xxxxxx",
    "project_id" : "xxxxxxxb4dac4055888643b3xxxxxx",
    "update_time" : 1687167926377,
    "update_user" : "xxxxxxxx"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 工作空间

相关文档