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 文字以下で、UPPER_SNAKE_CASE を表す正規表現 [A-Z][A-Z0-9_]+[A-Z0-9] に一致する必要があります。

domain

string

「理由」が属する論理グループ。通常、エラー ドメインはエラーを生成したツールまたはプロダクトの登録済みサービス名です。例: 「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" }