API 操作の呼び出し時にエラーが発生した場合は、エラーメッセージを OpenAPI Troubleshoot ページにコピーして、ソリューションを検索できます。
エラーメッセージの取得
OpenAPI Explorer のデバッグページから
SDK 呼び出しから
CLI から
Terraform から
Alibaba Cloud Developer Toolkit から
API エラーの診断
異なる Alibaba Cloud アカウント間、または同じアカウント内の異なる RAM ユーザーのエラーメッセージをクエリするには、まず必要な権限を取得する必要があります。 詳細については、「アカウント間の API エラー診断の権限付与」をご参照ください。
エラーメッセージを取得したら、完全な JSON エラー応答をコピーするか、RequestId、Code、または Message パラメーターの値のみを ページにコピーして、ソリューションを検索できます。
たとえば、Elastic Compute Service (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"
}パラメーターの説明は次のとおりです。
RequestId：リクエスト ID です。 リクエスト ID を ページにコピーして、ソリューションを取得できます。
HostId：サーバーのホスト ID です。
Code：エラーコードです。
Message：詳細なエラーメッセージです。 このメッセージを使用して、リクエストパラメーターのトラブルシューティングを行います。 この例では、指定された ImageId が無効であることを示しています。 エラーを解決するには、有効なイメージ ID を使用してください。
Recommend：この特定の問題に関するエラー診断ページへの直接リンクです。
SDK を使用する場合など、一部のシナリオでは、完全な JSON エラー応答を取得できないことがあります。 その場合でも、RequestId、Code、または Message パラメーターの値を ページにコピーするだけで問題を診断できます。 最も正確な結果を得るには、RequestId を使用することを推奨します。
次の図は、リクエスト ID を使用して診断ソリューションを取得する方法を示しています。
診断ソリューションの表示
OpenAPI Troubleshoot ページには、[診断ソリューション] タブと [ログ情報] タブがあります。 [診断ソリューション] タブには、エラーに対応するソリューションが表示されます。 この例では、エラーメッセージ The specified ImageId does not exist. に対して、次のソリューションが提供されます。
指定されたイメージは、このユーザーアカウントには存在しません。 イメージ ID が正しいかどうかを確認してください。
このソリューションに基づき、リクエスト内の `ImageId` パラメーターが正しいことを確認する必要があります。
ログとリクエスト詳細の確認
元のリクエストボディを保存していない場合でも、OpenAPI Troubleshoot ページからリクエストパラメーター、応答、およびその他の情報を取得できます。
リクエスト ID「6BE56E05-XXXX-XXXX-XXXX-FD90C4FFD581」を例に、[ログ情報] タブを開きます。 このタブでは、API 呼び出しトレース、完全なエラー応答、および元のリクエスト内容を視覚的に分析できます。 この情報により、問題の特定と解決が容易になります。
