文档首页> 云地图服务 KooMap> API参考> API> 工作共享空间> 查询工作共享空间列表
更新时间：2024-05-17 GMT+08:00
查看PDF
分享

查询工作共享空间列表

功能介绍

该接口用于分页查询工作共享空间列表，支持过滤条件：

  • 工作共享空间名称（workspace_name）：支持模糊查询。

  • 工作共享空间是否置顶显示：最多可置顶4个工作共享空间。

  • 创建时间范围（create_time_from和create_time_to）：UTC时间格式字符串，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。

  • 更新时间范围（update_time_from和update_time_to）：UTC时间格式字符串，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。

  • 分页参数：偏移量offset（缺省值为0），每页限制数量limit（缺省值为10）。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/workspaces

表1 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量。查询时忽略的记录数量。

最小值：0

最大值：2147483647

缺省值：0

limit

否

Integer

分页大小。

最小值：1

最大值：100

缺省值：10

workspace_ids

否

Array

根据工作共享空间ID查询。

workspace_name

否

String

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

star

否

Boolean

工作共享空间是否置顶显示（最多可置顶4个）。

  • 0：否

  • 1：是

create_time_from

否

String

创建工作共享空间的起始时间。查询在该时间之后创建的工作共享空间。接收UTC时间格式字符串，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。

create_time_to

否

String

创建工作共享空间的截止时间。查询在该时间之前创建的工作共享空间。接收UTC时间格式字符串，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。

update_time_from

否

String

更新工作共享空间的起始时间。查询在该时间之后更新的工作共享空间。接收UTC时间格式字符串，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。

update_time_to

否

String

更新工作共享空间的截止时间。查询在该时间之前更新的工作共享空间。接收UTC时间格式字符串，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。

order_by

否

String

排序字段。置顶空间默认排列在列表最前面，并且根据该排序字段组合排序。

  • create_time_asc：按照创建时间升序排列。

  • create_time_desc：按照创建时间降序排列。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

IAM Token信息，用于租户鉴权，该字段由租户请求IAM的Token接口获得。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

data

Array of WorkspaceDto objects

工作共享空间列表。

page

Page object

分页信息。
表4 WorkspaceDto

参数

参数类型

描述

workspace_id

String

工作共享空间ID。

workspace_name

String

工作共享空间名称。

workspace_description

String

工作共享空间描述。

tenant_domain_id

String

华为云IAM租户账号ID。

creator

String

创建人。

latest_operator

String

最近修改人。

create_time

String

创建时间。返回UTC时间格式字符串，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。

update_time

String

更新时间。返回UTC时间格式字符串，格式为yyyy-MM-dd'T'HH:mm:ss'Z'。

star

Integer

工作共享空间是否置顶显示（最多可置顶4个）。

can_delete

Boolean

工作共享空间是否允许删除标志位。当工作共享空间置顶显示或者该空间下存在任务时，取值为“true”，表示不可以删除。
表5 Page

参数

参数类型

描述

offset

Integer

偏移量，表示从第几条数据开始查询。

limit

Integer

每页包含的查询记录数量。

total

Integer

符合查询条件的记录总数。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。格式为：KMP.XXXXXXXX，其中X表示数字。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。格式为：KMP.XXXXXXXX，其中X表示数字。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：2

最大长度：512

请求示例

该请求用来分页查询工作共享空间列表，从第0个开始，查询10条符合条件的工作共享空间。

GET https://{Endpoint}/v1/workspaces?offset=0&limit=10

响应示例

状态码： 200

请求成功。

{
  "data" : [ {
    "workspace_id" : "8c008cabac124f74ad7deba48e1bdf7a",
    "workspace_name" : "测试空间1",
    "workspace_description" : "空间描述",
    "creator" : "xxxx",
    "latest_operator" : "xxxx",
    "create_time" : "2023-05-23T07:57:14Z",
    "update_time" : "2023-05-23T07:57:14Z",
    "star" : 0,
    "can_delete" : false
  }, {
    "workspace_id" : "cd8a29375dc0452889e3cce805bace1d",
    "workspace_name" : "测试空间2",
    "workspace_description" : "空间描述",
    "creator" : "xxxx",
    "latest_operator" : "xxxx",
    "create_time" : "2023-05-23T07:36:30Z",
    "update_time" : "2023-05-23T07:36:30Z",
    "star" : 0,
    "can_delete" : true
  } ],
  "page" : {
    "offset" : 0,
    "limit" : 2,
    "total" : 12
  }
}

状态码

状态码

描述

200

请求成功。

400

非法请求。

500

服务内部错误。

错误码

请参见错误码。

父主题： 工作共享空间
分享：

    相关文档

    相关产品