Query Space

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

Based on the space ID, query the basic information about the specified space.

API address

GET: /v2.0/cloud/space/{space_id}

Request parameter

Parameter name	Type	IN	Required	Description
space_id	Long	uri	true	The ID of the specified space.

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
id	Long	The ID of the specified space.
name	String	The name of the specified space.
parent_id	Long	The ID of the specified parent space.
root_id	Long	The ID of the specified root space.

Request example

GET: v2.0/cloud/space/{1500****}

Return example

{
    "result": {
        "parent_id": "1500****",
        "name": "My Space",
        "root_id": "1500****",
        "id": "1500****"
    },
    "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 DocDelete Space

Next DocQuery Space List