11.17　エラーオブジェクト

リクエストに対してエラーが発生した場合、HTTPステータスコードとともに、エラーオブジェクトが返却されます。

エラーオブジェクトのスキーマを次の表に示します。

属性	データ型	説明
errorSource	string	エラーが発生したURL
messageId	string	メッセージID
message	string	エラーメッセージの内容
cause	string	エラーの要因
solution	string	エラーの対処
errorCode	string	ストレージシステムのエラーコードストレージシステムでエラーが発生して、次に示すエラーコードがある場合にだけ値が返ります。 SSB1コード SSB2コードストレージシステムのエラーコードは、ストレージシステムの保守に必要になります。

ストレージシステムでエラーが発生した場合のエラーオブジェクトの例：

{
  "errorSource": "/ConfigurationManager/simple/v1/objects/volumes/100/actions/expand/invoke",
  "messageId": "KART70000-E",
  "message": "The specified volume is being used by another program product, or format in progress. Operation could not be completed. Wait for a while and try again. Confirm the volume is not in use by other program product.",
  "errorCode": {
    "SSB1": "B96B",
    "SSB2": "AF2E"
  }
}

エラーが発生しているが、一部だけ情報が取得できている、または操作が一部だけ完了している場合のエラーオブジェクトのスキーマを次の表に示します。

属性	データ型	説明
errorResponses	object[]	エラーオブジェクトの詳細情報 `errorSource`（string）エラーが発生したURL `messageId`（string）メッセージID `message`（string）エラーメッセージの内容 `cause`（string）エラーの要因 `solution`（string）エラーの対処 `errorCode`（object）ストレージシステムのエラーコードストレージシステムでエラーが発生して、次に示すエラーコードがある場合にだけ値が返ります。 SSB1コード SSB2コードストレージシステムのエラーコードは、ストレージシステムの保守に必要になります。
partialSuccessResponses	object[]	エラーが発生しているが、一部だけ情報が取得できている、または操作が一部だけ完了している場合に値が返ります。すべて失敗している場合、空の配列が返ることがあります。

属性

データ型

説明

errorResponses

object[]

エラーオブジェクトの詳細情報

errorSource（string）
エラーが発生したURL
messageId（string）
メッセージID
message（string）
エラーメッセージの内容
cause（string）
エラーの要因
solution（string）
エラーの対処
errorCode（object）
ストレージシステムのエラーコード

ストレージシステムでエラーが発生して、次に示すエラーコードがある場合にだけ値が返ります。
- SSB1コード
- SSB2コード
ストレージシステムのエラーコードは、ストレージシステムの保守に必要になります。

partialSuccessResponses

object[]

エラーが発生しているが、一部だけ情報が取得できている、または操作が一部だけ完了している場合に値が返ります。

すべて失敗している場合、空の配列が返ることがあります。

ストレージシステムでエラーが発生したが、操作が一部だけ完了している場合のエラーオブジェクトの例：

{
  "errorResponses": [
    {
      "errorSource": "/ConfigurationManager/simple/v1/objects/snapshots",
      "messageId": "KART70000-E",
      "message": "The specified volume does not exist. Check the parameter and try again. If this problem occurs repeatedly, contact customer support.",
      "errorCode": {
        "SSB1": "2E20",
        "SSB2": "0000"
      }
    }
  ],
  "partialSuccessResponses": [
    {
      "statusResource": "/ConfigurationManager/simple/v1/objects/command-status/3"
    }
  ]
}

11.17 エラーオブジェクト

11.17　エラーオブジェクト