Platform API

錯誤代碼

（以下內容均翻譯自英文版文件，最新資訊及內容敬請切換至英文語系參考原文）

 

HTTP 狀態碼

當您呼叫平台 API 時，會以標準 HTTP 狀態碼作出回應。分類如下：

HTTP 狀態碼 描述
2xx 成功的回應
4xx 客戶端錯誤
5xx 伺服器錯誤

 

錯誤代碼

當 API 出錯時，將提供標準化的回應格式，其結構如下：

{
  "code": error_code,
  "message": "error_message",
  "details": [
    {
      "@type": "string",
      ...
    }
  ]
}

回應中的屬性描述如下：

屬性 類型 描述
code integer 這是一個標準化的錯誤代碼，軟體可利用它來確定如何處理該錯誤。
message string 對錯誤的可讀解釋，提供了出錯原因的來龍去脈。
details array[object] 這是一個附加資訊物件數組，可提供有關錯誤的更多資訊。

 

詳細物件

屬性 類型 描述
@type string 標識序列化協議緩衝區報文的類型。
reason string 提供錯誤原因。
domain string 表示發生錯誤的 API 網域
metadata string 包含有關錯誤的其他詳細資訊，例如更全面的錯誤資訊。

 

 

更新於