获取工作空间列表
功能介绍
获取工作空间列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{instance_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
instance_id |
是 |
String |
DataArts Studio实例ID,获取方法请参见实例ID和工作空间ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每次查询的数据连接条数的限制量,默认20。 |
offset |
否 |
Integer |
数据偏移量,默认0。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,使用Token认证时必选。通过调用ManageOne平台的IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
当前工作空间用户记录数 |
total_page |
Integer |
查询结果总页数 |
data |
Array of Workspacebody objects |
工作空间列表 |
参数 |
参数类型 |
描述 |
---|---|---|
bad_record_location_name |
String |
脏数据OBS路径 |
description |
String |
工作空间描述 |
eps_id |
String |
企业项目ID,获取方法请参见项目ID和账号ID。 |
job_log_location_name |
String |
作业日志OBS路径 |
name |
String |
工作空间名称 |
id |
String |
工作空间ID ,获取方法请参见实例ID和工作空间ID。 |
is_default |
Integer |
是否为默认空间,0为私有空间,1为默认空间,2为公共空间 |
owner_name |
String |
创建者名称 |
project_id |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
domain_id |
String |
租户id,可在IAM侧用户信息中查询账号ID |
instance_id |
String |
DataArts Studio实例ID,获取方法请参见实例ID和工作空间ID。 |
create_time |
Number |
创建时间 |
create_user |
String |
创建用户名称 |
member_num |
Integer |
当前工作空间成员数量 |
update_time |
Number |
更新时间 |
update_user |
String |
更新用户名称 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
返回的错误信息。 |
error_code |
String |
返回的错误码。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
返回的错误信息。 |
error_code |
String |
返回的错误码。 |
请求示例
无
响应示例
状态码: 400
{ "error_code" : "DAYU.4402", "error_msg" : "The operation failed, detail msg {0}." }
状态码: 500
{ "error_code" : "DAYU.3531", "error_msg" : "Internal server error: {0}" }
状态码
状态码 |
描述 |
---|---|
200 |
Success,返回工作空间信息列表 |
400 |
BadRequest |
500 |
Internal Server Error |