OpenAPI報錯診斷
調(diào)用OpenAPI遇到報錯時,您可復制報錯信息到OpenAPI問題診斷頁面自助獲取解決方案。
獲取報錯信息
API在線調(diào)試頁面
SDK 調(diào)用
CLI 調(diào)用
Terraform 調(diào)用
Alibaba Cloud Developer Toolkit
診斷OpenAPI問題
當前診斷頁面僅支持RAM用戶自查或阿里云賬號(主賬號)查詢自身及其RAM用戶的請求和報錯信息,不支持RAM用戶間互查,也不支持阿里云賬號(主賬號)間互查。
獲取到報錯信息之后,您可以直接復制完整的JSON內(nèi)容或僅復制報錯信息中的RequestId參數(shù)或者Code、Message到OpenAPI問題診斷頁面自助獲取解決方案。
以調(diào)用云服務器 ECS的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"
}
各參數(shù)解釋如下:
RequestId:請求唯一標識,可復制RequestId到OpenAPI問題診斷自助獲取解決方案。
HostId:服務端主機標識。
Code:錯誤碼信息。
Message:詳細錯誤信息,可通過此內(nèi)容排查入?yún)栴},例子中即報錯ImageId傳遞了錯誤的鏡像ID,通過此信息調(diào)整ImageId為正確的鏡像ID即可解決此報錯。
Recommend:錯誤診斷鏈接,可直接復制該字段跳轉(zhuǎn)到錯誤診斷頁面獲取解決方案。
當在實際業(yè)務場景中,如使用SDK時,可能無法直接獲取完整報錯信息的JSON,此時也可直接復制RequestId或者Code、Message到OpenAPI問題診斷獲取解決方案,推薦使用RequestId,獲取方案相對精準。
使用RequestId獲取的解決方案如下圖所示:
查看診斷方案
如上圖所示,頁面下方有診斷方案和日志信息兩個頁簽,其中診斷方案頁簽將展示所匹配的解決方案信息,例如查詢的報錯信息是The specified ImageId does not exist.
,對應給出的方案如下:
指定的鏡像在該用戶賬號下不存在,請您檢查鏡像 ID 是否正確。
根據(jù)方案中的內(nèi)容,檢查入?yún)mageId的值是否填入的正確。
檢查入?yún)?/b>
在實際業(yè)務場景中,可能未保存報錯時請求體內(nèi)容,也可通過OpenAPI問題診斷獲取請求入?yún)ⅰ⒄埱箜憫推渌畔ⅰ?/p>
以報錯RequestId:6BE56E05-XXXX-XXXX-XXXX-FD90C4FFD581為例,單擊日志信息,從下圖可看到此次請求的調(diào)用鏈可視化分析、完整報錯信息和請求內(nèi)容等,可通過這些日志更具體地定位問題和解決問題。