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

「原因」所屬的邏輯分組。錯誤網域通常是產生錯誤的工具或產品的註冊服務名稱。例如「pubsub.googleapis.com」。如果錯誤是由某些常見基礎架構產生,錯誤網域必須是可識別基礎架構的全球專屬值。如果是 Google API 基礎架構,錯誤網域為「googleapis.com」。

metadata

map (key: string, value: string)

這項錯誤的額外結構化詳細資料。

鍵必須符合 [a-z][a-zA-Z0-9-_]+ 的規則運算式,但最好是 lowerCamelCase。長度不得超過 64 個半形字元。如要找出超出上限的目前值,單位應包含在鍵中,而非值中。舉例來說,如果用戶端超出單一 (批次) 要求可建立的執行個體數量,則應傳回 {"instanceLimitPerRequest": "100"},而非 {"instanceLimit": "100/request"}

這個物件中包含 "key": value 組合的清單,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }