Error object

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
An error object represents error information that is returned when the request processing fails.

If the API processing fails, an error object is returned as response data. The following explains the schema of an error object.

Attribute

Data type

Description

errorSource

link

URL where the error occurs

messageId#

string

Message ID

message

string

Content of the error message

cause

string

Cause of the error

solution

string

Solution to the error

solutionType

string

Category of the solution to the error

  • RETRY: Error that can be resolved by retrying the request
  • SEE_ERROR_DETAIL: Error that must be resolved by taking the action described in the error message

If RETRY is returned as the value of this attribute, retry the request that failed.

You can check the details of the request by checking the value of request of the job object.

errorCode

object

Error code from the storage system

A value is returned only if an error occurs in the storage system and thus one of the following error codes is issued.

  • The SSB1 code and SSB2 code of CCI
  • An error code of CCI

Storage system error codes are required for maintenance of the storage system.

detailCode

string

Detailed information about the error

The information is displayed in the following format:

nnnnnZ-TYPEoutput-format-for-each-TYPE

Example:

40097E-1-30000E-2-2EDA-00EE
  • nnnnnZ

    Displays the message ID of the REST API.

    • nnnnn

      Serial number of the message

    • Z

      Message type

      I : Information

      W : Warning

      E : Error

  • TYPE

    Displays the type of the error.

    • 0: An error that occurred on the REST API server side

    • 1: An error that occurred on the REST API server on the remote storage system side (for remote copy)

    • Other than the preceding: An error that occurred on the storage system side

  • output-format-for-each-TYPE

    The output format varies depending on the value of TYPE.

    • When the value is 0:

      No information is output.

    • When the value is 1:

      The value of the detailCode attribute for the REST API server on the remote storage system side is displayed.

    • When the value is 2:

      Information about the CCI error is displayed in the following format:

      - SSB1-code- SSB2-code

      For details, see the CCI manual.

    • When the value is 3:

      An error code of CCI is displayed.

      For details, see the CCI manual.

    • When the value is 4:

      Information about an error that occurs in the GUM is displayed in the following format:

      - part-code- error-code

      For details, see the manual Hitachi Device Manager - Storage Navigator Messages.

    • When the value is 5:

      Information about an error that occurs in the SVP is displayed in the following format:

      - part-code- error-code

      For details, see the manual Hitachi Device Manager - Storage Navigator Messages.

#: The name of the attribute is sometimes returned as the messageID.

Example of an error object that might be returned if an error occurs in the REST API server:

{
  "errorSource": "/ConfigurationManager/v1/objects/ldevs",
  "messageId": "KART20008-E",
  "message": "Required parameters are not specified.",
  "solution": "Check parameters.",
  "solutionType": "SEE_ERROR_DETAIL",
  "detailCode": "20008E-0"
}

Example of an error object that might be returned if an error occurs in the storage system:

{
  "errorSource": "/ConfigurationManager/v1/objects/ldevs/16",
  "messageId": "KART30000-E",
  "message": "An error occurred in the storage system. (message = The state of the pool is incorrect.)",
  "cause": "An error occurred during execution of a CCI command.",
  "solution": "See the manual of the CCI and remove the cause of the error.",
  "solutionType": "SEE_ERROR_DETAIL",
  "errorCode": {
    "SSB1": "2E10",
    "SSB2": "6014"
  },
  "detailCode": "30000E-2-2E10-6014"
}

The following shows an output example of the detailCode attribute:

If an error occurs on the REST API server (message ID: KART40231-E)

"detailCode": "40231E-0"

If an error occurs on the REST API server on the remote storage system side (message ID: KART40097-E, value of the detailCode attribute for the REST API server on the remote storage system side: 30000E-2-2EDA-00EE)

"detailCode": "40097E-1-30000E-2-2EDA-00EE"

If an error occurs on the storage system side (message ID: KART30000-E, SSB1 code: 2EDA, SSB2 code: 00EE)

"detailCode": "30000E-2-2EDA-00EE"

If an error occurs on the storage system side (message ID: KART30000-E, CCI error code: EX_INVARG)

"detailCode": "30000E-3-EX_INVARG"

If an error occurs on the storage system side (message ID: KART30007-E, part code: 30762, error code: 204092)

"detailCode": "30007E-4-30762-204092"

If an error occurs on the storage system side (message ID: KART30005-E, part code: 03005, error code: 078040)

"detailCode": "30005E-5-03005-078040"