エラー

次のセクションでは、それぞれ v2 および v1 リソースメソッドのエラーモデルが説明されます。

資源エラーモデル v2

デフォルトでは、リソースメソッドは 200 OK ステータスで応答します。リクエストが失敗したとき、Open Cloud は標準のエラーコードを返します。すべてのエラー応答には、次の形式が含まれています：

• code - HTTP ステータスコードを表示します。
• message - エラーを説明するメッセージ。
• details - エラーに関するより多くの情報を含むオブジェクト

例のエラー
{
  "code": "INVALID_ARGUMENT",
  "message": "The provided filter is invalid.",
  "details": [
    {
      ...
    }
  ]
}

コード

次の表では、code の可能な値を説明します。

資源エラーモデル v1

すべてのエラー応答には、同じ標準形式があり、それには以下が含まれます：

• すべてのオープンクラウドエンドポイントに適用できる高レベルの原因の error フィールド。
• 説明的なエラー message 、これはエラーをさらに説明します。
• 各APIに特有のエラーの詳細をカバーする errorDetails オブジェクト。

エラーの根本原因を分析するには、error フィールドと errorDetails フィールドの値を参照してください。 フィールドを使用して、エラー処理の補助として、時々 フィールドと同じレベルの詳細をカバーしない可能性があるためです。

標準データストアのエラー応答の例
{
  "error": "INVALID_ARGUMENT",
  "message": "Invalid cursor.",
  "errorDetails": [
    {
      "errorDetailType": "DatastoreErrorInfo",
      "datastoreErrorCode": "InvalidCursor"
    }
  ]
}

例のエラー応答は、高レベルのオープンクラウド error を INVALID_ARGUMENT 、エラー message を InvalidCursor 、そして errorDetails 特定のデータストア と datastoreErrorCode を InvalidCursor として示します。応答の error および datastoreErrorCode フィールドから、エラーを引き起こした無効なカーソルパラメータを通過したことを理解できます。その後、カーソルパラメータを修正して問題を解決できます。

注文されたすべてのデータストアのエラー応答には、次の形式が含まれています：

データストアの順番付けエラー応答の例
{
  "code": "INVALID_ARGUMENT",
  "message": "Invalid cursor."
}

The code には高レベルのエラーのストリングが含まれ、The message にはエラーに関連する特定の詳細が含まれます

コード

次の表を参照して、すべての高レベルのオープンクラウドエラーの概要をまとめます。