Modify Space Information

Last Updated on : 2024-04-07 09:44:04download

Based on the space ID, modify the name and description of the specified space.

API address

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

Request parameter

Parameter nameTypeINRequiredDescription
space_idLonguritrueThe ID of the specified space.

Description of body

Parameter nameTypeINRequiredDescription
nameStringbodyfalseThe name of the specified space.
descriptionStringbodyfalseThe description 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_codeStringThe error code. For more information, see the error codes.
error_msgStringThe message that is returned if the request fails. It is empty if the request is successful.
resultBooleanIndicates whether the space is modified successfully.

Request example

PUT: v2.0/cloud/space/{7073****}
  "name": "test space",
  "description": "This is a test space."

Return example

    "result": true,
    "success": true

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.