本頁面提供應用程式開發人員總覽,說明如何排解 Google API 和 Google Cloud API 的使用問題。
背景
Google API 是由 Google 服務提供的網路 API,應用程式可透過 JSON HTTP 和 gRPC,從不同環境存取 Google API。建議開發人員在應用程式中使用 Google 提供的用戶端程式庫。這些程式庫會實作常見的樣板邏輯,例如驗證和清單分頁,大幅減少開發負擔和常見錯誤。
詳情請參閱「用戶端程式庫說明」。
開始使用
如果您是 Google API 的新手,請按照「開始使用」頁面完成應用程式的準備步驟。您應先使用 curl -v
指令,將測試要求傳送至要使用的 Google API。
您可以使用這項工具試用 Google API,完全不需要編寫程式碼。
您通常可以在開始開發實際應用程式前解決許多問題。
詳情請參閱「開始使用」一文。
使用指標排解問題
Google API 提供免費的 API 指標,涵蓋 API 用量的常見層面,包括要求計數、錯誤、延遲時間、要求和回應大小。這些資料可提供應用程式和位置的精細維度。開發人員可以找出異常的 API 用量,並找出潛在的根本原因。舉例來說,400 錯誤次數增加可能表示最近更新的應用程式有邏輯錯誤,或是要求和回應大小增加可能導致應用程式效能變慢。
詳情請參閱「監控 API 使用情形」一文。
使用記錄檔排解問題
基於安全和隱私權考量,Google API 通常不會向應用程式開發人員提供 API 記錄。強烈建議應用程式開發人員在用戶端記錄 API 錯誤。您可以將錯誤記錄到本機儲存空間,或記錄到遠端記錄 API,例如 Cloud Logging API。
記錄通常會提供比指標更詳細的錯誤資訊,例如錯誤訊息和錯誤詳細資料。這類資訊非常實用,通常也是排解 API 錯誤的必要條件。開發人員發現 API 使用情形有任何問題時,可以查詢記錄檔找出錯誤訊息和錯誤詳細資料,並利用這些資訊解決錯誤或聯絡支援團隊。
Cloud 稽核記錄
對於安全性敏感活動,Google Cloud 產品可能會產生稽核記錄,其中包含活動的詳細資訊。這些記錄是排解 Google Cloud API 使用問題的絕佳資訊來源。舉例來說,VPC Service Controls 試營運功能會產生稽核記錄,供管理員評估即將發生的政策變更。
詳情請參閱「Cloud 稽核記錄」。
解決錯誤
如果 Google API 使用情況發生問題,且您已找到對應的指標和記錄,請按照 API 設計指南的「錯誤」頁面解決錯誤。
一般來說,每個 API 錯誤都有 3 項資訊:錯誤代碼、錯誤訊息和錯誤詳細資料:
- 應用程式可透過錯誤代碼,在較高的層級處理錯誤,例如在發生
503
錯誤後重試,或在發生401
錯誤後重新驗證使用者。 應用程式開發人員可透過錯誤訊息瞭解錯誤,並修正應用程式邏輯。
錯誤詳細資料包含額外資訊,應用程式可用於以程式輔助方式處理錯誤。
詳情請參閱「錯誤」頁面。