調用API報錯診斷 - OpenAPI Explorer

調用OpenAPI遇到報錯時，您可複製報錯資訊到OpenAPI問題診斷頁面自助擷取解決方案。

擷取報錯資訊

API線上調試頁面

SDK 調用

CLI 調用

Terraform 調用

Alibaba Cloud Developer Toolkit

診斷OpenAPI問題

重要

當前診斷頁面僅支援RAM使用者自查或阿里雲帳號（主帳號）查詢自身及其RAM使用者的請求和報錯資訊，不支援RAM使用者間互查，也不支援阿里雲帳號（主帳號）間互查。

擷取到報錯資訊之後，您可以直接複製完整的JSON內容或僅複製報錯資訊中的RequestId參數或者Code、Message到頁面自助擷取解決方案。

以調用Elastic Compute Service的RunInstances介面報錯為例，報錯資訊如下所示：

{
  "RequestId": "6BE56E05-XXXX-XXXX-XXXX-FD90C4FFD581",
  "HostId": "ecs.ap-southeast-3.aliyuncs.com",
  "Code": "InvalidImageId.NotFound",
  "Message": "The specified ImageId does not exist.",
  "Recommend": "https://api.alibabacloud.com/troubleshoot?intl_lang=EN_US&q=InvalidImageId.NotFound&product=Ecs&requestId=6BE56E05-XXXX-XXXX-XXXX-FD90C4FFD581"
}

各參數解釋如下：

RequestId：請求唯一標識，可複製RequestId到自助擷取解決方案。
HostId：服務端主機標識。
Code：錯誤碼資訊。
Message：詳細錯誤資訊，可通過此內容排查入參問題，例子中即報錯ImageId傳遞了錯誤的鏡像ID，通過此資訊調整ImageId為正確的鏡像ID即可解決此報錯。
Recommend：錯誤診斷連結，可直接複製該欄位跳轉到錯誤診斷頁面擷取解決方案。

當在實際業務情境中，如使用SDK時，可能無法直接擷取完整報錯資訊的JSON，此時也可直接複製RequestId或者Code、Message到擷取解決方案，推薦使用RequestId，擷取方案相對精準。

使用RequestId擷取的解決方案如下圖所示：

查看診斷方案

如上圖所示，頁面下方有診斷方案和日誌資訊兩個頁簽，其中診斷方案頁簽將展示所匹配的解決方案資訊，例如查詢的報錯資訊是The specified ImageId does not exist.，對應給出的方案如下：

指定的鏡像在該使用者帳號下不存在，請您檢查鏡像 ID 是否正確。

根據方案中的內容，檢查入參ImageId的值是否填入的正確。

檢查入參

在實際業務情境中，可能未儲存報錯時請求體內容，也可通過OpenAPI問題診斷擷取請求入參、請求響應和其它資訊。

以報錯RequestId：6BE56E05-XXXX-XXXX-XXXX-FD90C4FFD581為例，單擊日誌資訊，從下圖可看到此次請求的調用鏈可視化分析、完整報錯資訊和請求內容等，可通過這些日誌更具體地定位問題和解決問題。