查询工作空间 - ListWorkspaces
功能介绍
查询工作空间列表。
仅支持查看权限内支持访问的工作空间。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/instances/{instance_id}/workspaces
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
instance_id | 是 | String | 参数解释: 实例ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
project_id | 是 | String | 参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
name | 否 | String | 参数解释: 工作空间名称,支持模糊查询。 约束限制: 不涉及 取值范围: [0,100] 默认取值: 不涉及 |
offset | 否 | Integer | 参数解释: 偏移量(分页页数)。 约束限制: 不涉及 取值范围: [0,1000] 默认取值: 0 |
limit | 否 | Integer | 参数解释: 返回条目数(分页大小)。 约束限制: 不涉及 取值范围: [1, 1000] 默认取值: 10 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
count | Integer | 参数解释: 总条目数。 取值范围: 不涉及 |
page_data | Array of WorkspaceVO objects | 当前页的数据 |
参数 | 参数类型 | 描述 |
|---|---|---|
configs | Map<String,String> | 参数解释: 工作空间的configs配置的属性值。 取值范围:
|
create_time | Long | 参数解释: 工作空间的创建时间。 取值范围: 不涉及 |
create_user | String | 参数解释: 工作空间的创建者。 取值范围: 不涉及 |
description | String | 参数解释: 工作空间的描述信息。 取值范围: 不涉及 |
domain_id | String | 参数解释: 工作空间所属的账号ID。 取值范围: 不涉及 |
eps_id | String | 参数解释: 工作空间所属企业项目ID。 取值范围: 不涉及 |
id | String | 参数解释: 工作空间ID。 取值范围: 不涉及 |
instance_id | String | 参数解释: 实例ID。 取值范围: 不涉及 |
is_default | Integer | 参数解释: 是否为默认空间。 取值范围:
|
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=
查询工作空间列表。 响应示例
状态码:200
OK
{
"count" : 17,
"page_data" : [ {
"configs" : "configs",
"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 |
错误码
请参见错误码。

