Request headers

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
This section describes the request headers supported by the REST API.

Header

Category

Description

Specifiable value

Accept

Optional

Specifies the media type of the response.

*/* (json)

Default value: */* (json)

Content-Type

Optional

Specifies the media type of the request body.

If a request body is specified, the Content-Type header is specifiable. If a request body is not specified, this header is ignored even if specified.

application/json

Default value: application/json

Content-Length

Optional

Specifies the size of the request body.

You can specify the Content-Length header when specifying a request body. This header is automatically assigned depending on the specifications of the client software.

Specify the header, in bytes.

Default value: None

Authorization

Required

Specifies the authorization method and authorization credentials.

You do not need to specify this header for the API function that gets version information or for the API function that gets a list of storage systems.

When using the REST API, use different authorization methods appropriately, as shown below.

  • For session generation: Authorization is based on the user ID and password.
  • For operations other than the above: Authorization is based on the session.
Specify the header in one of the following formats. Specify the appropriate authentication method depending on the API.
  • Authentication based on the user ID and password

    Basic authorization-credentials

    For the authorization credentials, specify the user ID and password in a character string encoded by using Base64. Use the user ID and password of a user account that can perform operations on storage system resources.

  • Authorization based on the session

    Session token

    When the session was generated:

    Specify a token that was obtained when the session was generated.

Default value: None

Remote-Authorization

Required (for the API for the object types on the right)

Specifies the authorization credentials to be used when accessing the remote storage system. This header is used in the API for the following object types:
  • remote-mirror-copygroups
  • remote-mirror-copypairs
  • remote-storages

Specify the header in the following format:

Session token

Specify the token for the session that was generated in the remote storage system.#

Default value: None

Response-Max-Wait

Optional

Specifies the maximum wait time until a response is returned when an API request for asynchronous processing is issued. A response is returned when the specified time elapses after the REST API server accepted the API request.

If the processing finishes before the maximum wait time elapses, a response is returned at the time of completion.

Factors such as network status and load of the REST API server can delay acceptance of a response, so the wait time might be longer than the specified maximum time. Take these factors into account when specifying the maximum wait time.

Integers between 0 and 1800

Unit: Seconds

Default value: None

Response-Job-Status

Optional

Specifies the status of the job that is expected to return a response when an API request for asynchronous processing is issued. A response is returned when the job transits to the specified status or when the processing stops due to an error.

Specify the header in one of the following formats:

job-status;

or

job-status; Job-State=state-of-the-job

Default value: None

Job-Mode-Wait-Configuration​-Change

Optional

Specifies when the job status is to be changed to Completed when an API request for asynchronous processing is issued in pair operations.

Use this header for the API functions that meet the following conditions.

  • The object type is one of the following:
    • local-clone-copygroups
    • local-clone-copypairs
    • remote-mirror-copygroups
    • remote-mirror-copypairs
  • The HTTP method is either of the following:
    • POST
    • PATCH

Specify either of the following values:

  • Wait: Wait for data copying to finish, and then change the job status to Completed.
  • NoWait: Change the job status to Completed without waiting for data copying to finish.

If you specify NoWait, data copying continues even after the job status changes to Completed. To check whether data copying has finished, check the status of the target resource.

Default value: Wait

#: Specify at least 60 seconds for the timeout time of a session generated on the remote storage system. If you specify less than 60 seconds, the session on the remote storage system might time out, causing the execution of a request to fail.

If a header other than the above is specified, the specified header is ignored.

Response-Max-Wait and Response-Job-Status can be specified in combination. If both are specified, a response is returned when either condition is satisfied.

If neither Response-Max-Wait nor Response-Job-Status is specified, a response is returned immediately.