工作空间列表查询
功能介绍
工作空间列表查询:可通过工作空间名称、工作空间描述、创建时间等条件对租户的工作空间进行筛选。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id 最小长度：32 最大长度：64 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
是 |
Number |
偏移量 指定返回记录的开始位置，必须为数字，取值范围为大于或等于0， 最小值：0 最大值：999 缺省值：0 |
|
limit |
是 |
Number |
每页显示个数 最小值：1 最大值：100 缺省值：10 |
|
region_id |
否 |
String |
区域id 最小长度：32 最大长度：64 |
|
name |
否 |
String |
名称查询 最小长度：0 最大长度：64 |
|
description |
否 |
String |
描述查询 最小长度：0 最大长度：512 |
|
view_bind_id |
否 |
String |
视图绑定的空间id 最小长度：0 最大长度：36 |
|
view_bind_name |
否 |
String |
视图绑定的空间名称 最小长度：0 最大长度：64 |
|
create_time_start |
否 |
String |
创建时间开始，例如2024-04-26T16:08:09Z+0800 最小长度：0 最大长度：64 |
|
create_time_end |
否 |
String |
创建时间结束，例如2024-04-2T16:08:09Z+0800 最小长度：0 最大长度：64 |
|
is_view |
否 |
Boolean |
是否查询视图 true or false 缺省值：false |
|
ids |
否 |
String |
工作空间id数组，英文逗号分隔 最小长度：0 最大长度：999 |
|
normal_project_id |
否 |
String |
普通项目的项目id 最小长度：0 最大长度：36 |
|
enterprise_project_id |
否 |
String |
企业项目的项目id 最小长度：0 最大长度：36 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：2097152 |
|
content-type |
是 |
String |
application/json;charset=UTF-8 缺省值：application/json;charset=UTF-8 最小长度：0 最大长度：64 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
workspaces |
Array of CreateWorkspaceResponseBody objects |
空间信息 数组长度：0 - 100 |
|
count |
Number |
数据总量 最小值：2 最大值：999999999 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
工作空间id 最小长度：32 最大长度：36 |
|
create_time |
String |
创建时间 最小长度：0 最大长度：64 |
|
update_time |
String |
更新时间 最小长度：0 最大长度：64 |
|
name |
String |
工作空间名称 最小长度：1 最大长度：64 |
|
description |
String |
工作空间描述 最小长度：0 最大长度：512 |
|
creator_id |
String |
创建人id 最小长度：0 最大长度：36 |
|
creator_name |
String |
创建人名称 最小长度：0 最大长度：64 |
|
modifier_id |
String |
修改人id 最小长度：0 最大长度：36 |
|
modifier_name |
String |
修改人名称 最小长度：0 最大长度：64 |
|
project_id |
String |
所属项目id 最小长度：32 最大长度：36 |
|
project_name |
String |
所属项目名称 最小长度：1 最大长度：64 |
|
domain_id |
String |
所属租户id 最小长度：32 最大长度：36 |
|
domain_name |
String |
所属租户名称 最小长度：1 最大长度：64 |
|
enterprise_project_id |
String |
企业项目id 最小长度：0 最大长度：36 |
|
enterprise_project_name |
String |
企业项目名称 最小长度：0 最大长度：64 |
|
is_view |
Boolean |
是否是视图 |
|
region_id |
String |
区域id 最小长度：1 最大长度：64 |
|
view_bind_id |
String |
视图绑定的空间id 最小长度：0 最大长度：36 |
|
view_bind_name |
String |
视图绑定的空间名称 最小长度：0 最大长度：64 |
|
workspace_agency_list |
Array of workspace_agency_list objects |
仅用于视图场景，列出了该视图纳管的空间列表 数组长度：0 - 32 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
project_id |
String |
委托空间所属项目id 最小长度：32 最大长度：36 |
|
id |
String |
空间委托id 最小长度：32 最大长度：36 |
|
name |
String |
空间委托名称 最小长度：1 最大长度：64 |
|
region_id |
String |
委托空间所属region id 最小长度：1 最大长度：64 |
|
workspace_attribution |
String |
THIS_ACCOUNT:本账号空间,CROSS_ACCOUNT:跨账号空间 枚举值：
|
|
agency_version |
String |
用户创建托管空间时使用的IAM委托版本，V3或者V5 最小长度：1 最大长度：64 |
|
domain_id |
String |
委托租户id 最小长度：32 最大长度：64 |
|
domain_name |
String |
委托租户名称 最小长度：1 最大长度：64 |
|
iam_agency_id |
String |
iam委托id 最小长度：32 最大长度：64 |
|
iam_agency_name |
String |
iam委托名称 最小长度：1 最大长度：64 |
|
resource_spec_code |
Array of strings |
委托空间购买版本 最小长度：1 最大长度：64 数组长度：0 - 16 |
|
selected |
Boolean |
是否被视图选中 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 最小长度：0 最大长度：64 |
|
message |
String |
错误消息 最小长度：0 最大长度：1024 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 最小长度：0 最大长度：64 |
|
message |
String |
错误消息 最小长度：0 最大长度：1024 |
请求示例
无
响应示例
状态码： 200
请求成功
{
"count" : 1,
"workspaces" : [ {
"create_time" : "2024-07-02T09:25:17Z+0800",
"creator_id" : "b4*****************************46a",
"creator_name" : "l00644738",
"description" : "我的工作空间",
"domain_id" : "ac*****************************bf4",
"domain_name" : "scc****09",
"enterprise_project_id" : "",
"enterprise_project_name" : "",
"id" : "39*************bf",
"is_timeout" : null,
"is_view" : false,
"modifier_id" : "",
"modifier_name" : "",
"name" : "我的工作空间",
"project_id" : "15**************************da6",
"project_name" : "cn-north-4",
"region_id" : "cn-north-4",
"update_time" : "2024-07-02T09:25:17Z+0800",
"view_bind_id" : "",
"view_bind_name" : "",
"workspace_agency_list" : [ ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
请求参数有误 |
|
500 |
请求失败 |
错误码
请参见错误码。
