Supported HTTP methods

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
HTTP defines methods, which are operations that can be performed on resources.

The REST API supports the following HTTP methods.

HTTP method

Description

Processing method

GET

This method gets object information. Alternatively, this method gets a list of objects.

For example, this method can obtain a list of pools.

Synchronous

POST

  • This method creates new objects.

    For example, this method can create pools.

  • This method can perform specific actions to objects.

    For example, this method can expand pools.

Asynchronous

However, the following APIs are performed in synchronous processing.
  • Generating sessions
  • Uploading the files required for initial configuration
  • Getting information about an iSCSI target of a port on an external storage system
  • Performing a login test on an iSCSI target of an external storage system that is registered to a port on the local storage system
  • Backing up encryption keys

PATCH

This method changes the attributes or the state of an object.

For example, this method can change the pool threshold.

Asynchronous

However, the following API is performed in synchronous processing.
  • Setting the system date and time of a storage system

DELETE

This method deletes objects.

For example, this method can delete pools.

Asynchronous

However, the following APIs are performed in synchronous processing.
  • Discarding sessions

The following explains the processing method for the REST API (synchronous processing and asynchronous processing):

  • For synchronous processing, the processing results are returned in the response.
  • For asynchronous processing, the operation on the resource is registered as a job. In addition, the job information and the HTTP status code 202, which indicates that the processing has been accepted, are returned in the response. Subsequently, the registered job runs asynchronously. If registration of a job fails, the HTTP status code 500 is returned.
    Tip:
    • If you specify Completed for the Response-Job-Status in the request header (even for asynchronous processing operations), a response will be returned only after the job is complete.
    • For pair operations, you can use Job-Mode-Wait-Configuration-Change in the request header to specify the time when the job status changes to Completed. If you specify NoWait in the request header, the job status will change to Completed without waiting for data copying to finish.