ErrorInfo

エラーの原因を構造化された詳細で説明します。

「pubsub.googleapis.com」API が有効になっていない場合に、この API に接続しようとすると発生するエラーの例:

{ "reason": "API_DISABLED"
  "domain": "googleapis.com"
  "metadata": {
    "resource": "projects/123",
    "service": "pubsub.googleapis.com"
  }
}

このレスポンスは、pubsub.googleapis.com API が有効になっていないことを示しています。

在庫なしのリージョンで Spanner インスタンスを作成しようとしたときに返されるエラーの例:

{ "reason": "STOCKOUT"
  "domain": "spanner.googleapis.com",
  "metadata": {
    "availableRegions": "us-central1,us-east2"
  }
}
JSON 表現 
{
  "reason": string,
  "domain": string,
  "metadata": {
    string: string,
    ...
  }
}
フィールド
reason

string

エラーの理由。これは、エラーの直接的な原因を特定する定数値です。エラーの理由は、特定のエラー ドメイン内で一意です。最大 63 文字で、[A-Z][A-Z0-9_]+[A-Z0-9] の正規表現（UPPER_SNAKE_CASE を表す）に一致する必要があります。
domain

string

「reason」が属する論理グループ。通常、エラー ドメインは、エラーを生成するツールまたはプロダクトの登録済みサービス名です。例: 「pubsub.googleapis.com」。エラーが共通インフラストラクチャによって生成される場合、エラー ドメインは、インフラストラクチャを識別するグローバルに一意の値にする必要があります。Google API インフラストラクチャの場合、エラー ドメインは「googleapis.com」です。
metadata

map (key: string, value: string)

このエラーに関する構造化された追加の詳細情報。

キーは [a-z][a-zA-Z0-9-_]+ の正規表現に一致する必要がありますが、理想的には lowerCamelCase にする必要があります。また、長さは 64 文字に制限する必要があります。上限を超えた現在の値を特定する場合は、値ではなくキーに単位を含める必要があります。たとえば、クライアントが 1 回のリクエスト（バッチ）で作成できるインスタンス数を超えた場合、{"instanceLimit": "100/request"} ではなく {"instanceLimitPerRequest": "100"} が返されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }