QuotaFailure

割り当てチェックがどのように失敗したかを説明します。

たとえば、呼び出し元プロジェクトで 1 日の上限を超えた場合、サービスは、プロジェクト ID と超過した割り当て上限の説明を含む QuotaFailure の詳細を返します。呼び出し元プロジェクトでデベロッパー コンソールでサービスが有効になっていない場合、サービスはプロジェクト ID を返して service_disabled を true に設定できます。

割り当ての失敗の処理に関するその他の詳細については、RetryInfo 型と Help 型もご覧ください。

JSON 表現 
{
  "violations": [
    {
      object (Violation)
    }
  ]
}
フィールド
violations[]

object (Violation)

すべての割り当て違反について説明します。

違反

単一の割り当て違反を説明するために使用されるメッセージ タイプ。たとえば、1 日の割り当て量やカスタム割り当て量を超えた場合などです。

JSON 表現 
{
  "subject": string,
  "description": string,
  "apiService": string,
  "quotaMetric": string,
  "quotaId": string,
  "quotaDimensions": {
    string: string,
    ...
  },
  "quotaValue": string,
  "futureQuotaValue": string
}
フィールド
subject

string

割り当てチェックが失敗したサブジェクト。たとえば、「clientip:」や「project:」などです。
description

string

割り当てチェックがどのように失敗したかの説明。クライアントはこの説明を使用して、サービスの一般公開ドキュメントで割り当て構成の詳細を確認したり、デベロッパー コンソールで関連する割り当て上限を見つけて調整したりできます。

例: 「サービスが無効」または「読み取りオペレーションの 1 日の上限を超えました」。
apiService

string

QuotaFailure.Violation の送信元となる API サービス。割り当ての問題は、呼び出された API サービス以外の API サービスに起因することもあります。つまり、呼び出された API サービスの依存関係が QuotaFailure の原因である可能性があり、このフィールドには依存関係 API サービス名が設定されます。

たとえば、呼び出された API が Kubernetes Engine API（container.googleapis.com）で、Kubernetes Engine API 自体で割り当て違反が発生した場合、このフィールドは「container.googleapis.com」になります。一方、Kubernetes Engine API が Compute Engine API（compute.googleapis.com）で VM を作成するときに割り当て違反が発生した場合、このフィールドは「compute.googleapis.com」になります。
quotaMetric

string

違反した割り当ての指標。割り当て指標は、API リクエストや CPU などの使用量を測定する名前付きカウンタです。サービスでアクティビティ（仮想マシンの割り当てなど）が発生すると、1 つ以上の割り当て指標が影響を受ける可能性があります。

例: 「compute.googleapis.com/cpus_per_vm_family」、「storage.googleapis.com/internet_egress_bandwidth」。
quotaId

string

違反した割り当ての ID。「上限名」とも呼ばれます。API サービスのコンテキストにおける割り当ての一意の識別子です。

たとえば、「CPUS-PER-VM-FAMILY-per-project-region」などです。
quotaDimensions

map (key: string, value: string)

違反した割り当てのディメンション。グローバル以外の割り当ては、一連のディメンションに適用されます。割り当て指標はカウント対象を定義しますが、ディメンションはカウンタを増やす対象の側面を指定します。

たとえば、「リージョンあたりの VM ファミリーあたりの CPU」割り当ては、「リージョン」と「vm_family」のディメンションで「compute.googleapis.com/cpus_per_vm_family」指標に上限を適用します。違反がリージョン「us-central1」で VM ファミリー「n1」に対して発生した場合、quotaDimensions は次のようになります。

{ "region": "us-central1", "vm_family": "n1", }

割り当てがグローバルに適用される場合、quotaDimensions は常に空になります。

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

string (int64 format)

QuotaFailure の時点での適用済み割り当て値。

たとえば、CPU 数に対する QuotaFailure の時点での適用済み割り当て値が「10」の場合、このフィールドの値にはこの数量が反映されます。
futureQuotaValue

string (int64 format)

違反時にロールアウトされる新しい割り当て値。ロールアウトが完了すると、この値が quotaValue の代わりに適用されます。違反時にロールアウトが進行中の場合、このフィールドは設定されません。

たとえば、違反時にロールアウトが進行中で、CPU 数の割り当てが 10 から 20 に変更されている場合、このフィールドの値は 20 になります。