查询空间节点列表

更新时间：2023-11-23 06:15:11下载pdf

本文介绍查询空间节点列表的 API。

接口描述

根据空间 ID，查询子节点列表。若指定 only_sub 为 true，则仅查询直接子节点，否则查询全部子节点。如果不指定空间 ID，则查询一级空间列表。

接口地址

GET: /v2.0/cloud/space/child

请求参数

参数名	类型	参数位置	是否必填	说明
space_id	Long	query	false	目标空间 ID。若此参数为空，则查询云项目根目录下的空间子节点。
only_sub	Boolean	query	false	是否仅查询直接子节点。
last_row_key	Long	query	false	起始查询 ID，将返回结果中的 `last_row_key` 传入以获取下一页数据。
page_size	Integer	query	false	单页数据量大小。

返回参数

参数名	类型	说明
success	Boolean	请求是否成功。 `true`：请求成功。 `false`：请求失败。
error_code	String	详见错误码。
error_msg	String	错误信息，成功时为空。
result	Object	返回结果。

result 说明

参数名	类型	说明
data	List	子空间 ID 列表.
last_row_key	Long	起始查询 ID。
page_size	Integer	单页数据量大小。

请求示例

GET: /v2.0/cloud/space/child?spaceId=1&onlySub=true&lastRowKey=0&pageSize=100

返回示例

{
    "result": {
        "last_row_key": 15000003,
        "data": [
            15000002,
            15000003
        ],
        "page_size": 200
    },
    "success": true
}

错误码

参考错误码。

调用频率限制

参考调用频率限制。

上一篇查询空间

下一篇查询空间下资源列表