Query Space

Last Updated on : 2023-11-23 06:14:46download

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 nameTypeINRequiredDescription
space_idLonguritrueThe ID of the specified space.

Return parameter

Parameter nameTypeDescription
successBooleanIndicates whether the operation is successful. Valid values:
  • true: The operation succeeded.
  • false: The operation failed.
error_codeStringFor more information, see the error codes.
error_msgStringThe message that is returned if the request fails. It is empty if the request is successful.
resultObjectThe returned result.

Description of result

Parameter nameTypeDescription
idLongThe ID of the specified space.
nameStringThe name of the specified space.
parent_idLongThe ID of the specified parent space.
root_idLongThe 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.