2.15　エラーオブジェクト

エラーオブジェクトは、リクエストの処理に失敗したときに返すエラー情報のオブジェクトです。

APIの処理が失敗すると、レスポンスデータとしてエラーオブジェクトが返ります。エラーオブジェクトのスキーマを次に示します。

属性	データ型	説明
errorSource	link	エラーが発生したURL
messageId^※	string	メッセージID
message	string	エラーメッセージの内容
cause	string	エラーの要因
solution	string	エラーの対処
solutionType	string	エラーの対処の分類 `RETRY`：リトライで対処可能なエラー `SEE_ERROR_DETAIL`：エラーメッセージの内容に基づいた対処が必要なエラーこの属性に`RETRY`が返る場合、失敗したリクエストをリトライしてください。リクエストの内容は、ジョブオブジェクトの`request`の値で確認できます。
errorCode	object	ストレージシステムのエラーコードストレージシステムでエラーが発生して、次に示すエラーコードがある場合にだけ値が返ります。 RAID ManagerのSSB1コードおよびSSB2コード RAID Managerのエラーコード RMIのエラーコード1およびエラーコード2 ストレージシステムのエラーコードは、ストレージシステムの保守に必要になります。
detailCode	string	エラーの詳細な情報次の形式で表示されます。 <`nnnnnZ`>-<`TYPE`><`TYPEごとの出力形式`> <`nnnnnZ`> REST APIのメッセージIDを表示します。 `nnnnn` メッセージの通し番号 `Z` メッセージの種類 `I`：Information `W`：Warning `E`：Error <`TYPE`> エラーの種別を表示します。 `0`：REST APIサーバ側のエラー `1`：リモートストレージシステム側のREST APIサーバのエラー（リモートコピーの場合）上記以外：ストレージシステム側のエラー <`TYPEごとの出力形式`> `TYPE`の値によって、出力形式が次のように異なります。 `0`の場合出力されません。 `1`の場合リモートストレージシステム側のREST APIサーバの、`detailCode`属性の値が表示されます。 `2`の場合 RAID Managerのエラーについて、次の形式で出力されます。 -< `SSB1 コード`>-< `SSB2 コード`> 詳細については、RAID Managerのマニュアルを参照してください。 `3`の場合 RAID Managerのエラーコードが出力されます。詳細については、RAID Managerのマニュアルを参照してください。 `4`の場合 GUMで発生したエラーについて、次の形式で出力されます。 -< `部位コード`>-< `エラーコード`> 詳細については、マニュアルStorage Navigator メッセージガイドを参照してください。 `5`の場合 SVPで発生したエラーについて、次の形式で出力されます。 -< `部位コード`>-< `エラーコード`> 詳細については、マニュアルStorage Navigator メッセージガイドを参照してください。

注※　属性名はmessageIDで返ることがあります。

REST APIサーバでエラーが起きた場合のエラーオブジェクトの例

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

ストレージシステムでエラーが起きた場合のエラーオブジェクトの例

{
  "errorSource": "/ConfigurationManager/v1/objects/storages/836000123456/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 RAID Manager command.",
  "solution": "See the manual of the RAID Manager and remove the cause of the error.",
  "solutionType": "SEE_ERROR_DETAIL",
  "errorCode": {
    "SSB1": "2E10",
    "SSB2": "6014"
  },
  "detailCode": "30000E-2-2E10-6014"
}

detailCode属性の出力例を次に示します。

REST APIサーバでエラーが発生した場合（メッセージID：KART40231-E）

"detailCode": "40231E-0"

リモートストレージシステム側のREST APIサーバでエラーが発生した場合（メッセージID：KART40097-E、リモートストレージ側のREST APIサーバのdetailCode属性の値：30000E-2-2EDA-00EE）

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

ストレージシステム側でエラーが発生した場合（メッセージID：KART30000-E、SSB1コード：2EDA、SSB2コード：00EE）

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

ストレージシステム側でエラーが発生した場合（メッセージID：KART30000-E、RAID Managerのエラーコード：EX_INVARG）

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

ストレージシステム側でエラーが発生した場合（メッセージID：KART30007-E、部位コード：30762、エラーコード：204092）

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

ストレージシステム側でエラーが発生した場合（メッセージID：KART30005-E、部位コード：03005、エラーコード：078040）

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

2.15 エラーオブジェクト

2.15　エラーオブジェクト