Query Space List

Last Updated on : 2024-09-10 01:49:15

Based on the space ID, query a list of child nodes in the specified space. If you specify only_sub as true, you can only query direct child nodes. Otherwise, you can query all child nodes. If you do not specify a space ID, you query the list of the first-level spaces.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
space_id	Long	query	false	The ID of the specified space. If this parameter is empty, it will query the spaces under the root directory of the cloud project.
only_sub	Boolean	query	false	Specifies whether to only query the direct child nodes.
last_row_key	Long	query	false	The starting ID of the query. Pass in the `last_row_key` of the returned result to get the data of the next page.
page_size	Integer	query	false	The number of items returned per page.

Return parameter

Parameter name	Type	Description
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
error_code	String	For more information, see the error codes.
error_msg	String	The message that is returned if the request fails. It is empty if the request is successful.
result	Object	The returned result.

Description of result

Parameter name	Type	Description
data	List	The list of sub-space IDs.
last_row_key	Long	The starting ID of the query.
page_size	Integer	The number of items returned per page.

Request example

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

Return example

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

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocQuery Space

Next DocQuery Resources in Space