Update storage component state

Virtual Storage Platform One Object API Reference Guide

Version
3.0.x
File Size
270 KB
Audience
anonymous
Part Number
MK-24VSP1OB002-01

Updates the state of a storage component to ACTIVE, PAUSED, or READ_ONLY and returns all component settings with the updated state.

Endpoint

POST /storage_component/update_state

Request structure

{
  "id": "UUID",
  "storageComponentState": "ACTIVE"
}
Parameter Type Description
id UUID The ID of the storage component.
storageComponentState String The state of the storage component:
  • ACTIVE: The storage component is currently in use.
  • PAUSED: Usage of the storage component is currently paused.
  • READ_ONLY: The storage component is set as read-only access.

Response structure

The response returns the same parameters as the request.

Return codes

Status code

HTTP name

Description

200 OK The request was executed successfully.
400 Bad Request The request is missing a valid storage component or parameter.
401 Unauthorized Access was denied because credentials are not valid.
404 Not Found The requested storage component could not be found.
405 Method Not Allowed The specified HTTP method is not allowed for a storage component. Resend using POST.