インデックス
Status（メッセージ）
Status
Status 型は、REST API や RPC API などのさまざまなプログラミング環境に適した論理エラーモデルを定義します。これは gRPC によって使用されます。エラーモデルの設計では次のことを目標としています。
- 使い方が簡単で、ほとんどのユーザーが理解できる。
- 柔軟で予期しないニーズに対応できる。
概要
Status メッセージには、エラーコード、エラー メッセージ、エラーの詳細という 3 種類のデータが含まれています。エラーコードは google.rpc.Code の列挙値である必要がありますが、必要に応じて追加のエラーコードを受け入れることもできます。エラー メッセージは、デベロッパーによるエラーの理解と解決に役立つよう、デベロッパー向けの英語にする必要があります。ユーザー向けのローカライズされたエラー メッセージが必要な場合は、エラーの詳細にローカライズされたメッセージを入れるか、クライアントでローカライズします。オプションのエラーの詳細には、エラーに関する任意の情報を含めることができます。パッケージ google.rpc には、一般的なエラー条件で使用できるエラーの詳細タイプが事前に定義されています。
言語マッピング
Status メッセージはエラーモデルの論理表現ですが、必ずしも実際の送信形式ではありません。Status メッセージがさまざまなクライアント ライブラリやさまざまな送信プロトコルで公開されると、異なったマッピングが行われる場合があります。たとえば、Java では一部の例外にマッピングされる可能性があり、C では一部のエラーコードにマッピングされる可能性が高くなります。
他の使用法
API を使用した、または使用しないさまざまな環境でエラーモデルと Status メッセージを使用すると、さまざまな環境で一貫性のある使用感をデベロッパーに提供できます。
このエラーモデルの使用例には、次のようなものがあります。
部分的エラー。サービスでクライアントに部分的エラーを返す必要がある場合は、通常のレスポンスに
Statusを埋め込んで部分的エラーを表すことができます。ワークフロー エラー。通常のワークフローには複数のステップがあります。各ステップにはエラー報告の目的で、
Statusメッセージがある場合があります。バッチ オペレーション。クライアントでバッチ リクエストとバッチ レスポンスを使用する場合、
Statusメッセージは各エラーのサブレスポンスに 1 つずつ、バッチ レスポンスの中で直接使用する必要があります。非同期オペレーション。API 呼び出しでレスポンスに非同期オペレーションの結果を埋め込んでいる場合、このようなオペレーションのステータスは
Statusメッセージを使用して直接表す必要があります。ロギング。いくつかの API エラーがログに保存されている場合、メッセージ
Statusはセキュリティやプライバシー上の理由で必要とされる除去を行った後で、直接使用することができます。
| フィールド | |
|---|---|
code |
ステータス コード。 |
message |
デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして |
details[] |
エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。 |