この Topic では、JSON フォーマットで返される API 応答の例について説明します。 詳細については、「共通パラメーター」をご参照ください。
通常のレスポンス例
リクエストが成功すると、レスポンスパラメーターとリクエスト ID が返されます。 HTTP ステータスコードが 2xx である場合、呼び出しが成功したことを示します。 以下の通常のレスポンス例は JSON 形式です。
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
/* Response data */
}エラーレスポンスの例
API 呼び出しが失敗すると、HTTP ステータスコード 4xx または 5xx が返されます。 応答本文のエラーコードとメッセージを使用して、失敗の原因を特定できます。 応答には、グローバルに一意なリクエスト ID (RequestId) と、アクセスしたサイトの ID (HostId) も含まれます。 エラーの原因を特定できない場合は、プロダクト Q&A DingTalk グループ (35035130) にご参加ください。 迅速なサポートを受けるために、HostId と RequestId をご提供ください。 以下に、JSON フォーマットのエラーレスポンスの例を示します。
{
"RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
"HostId": "imagesearch.aliyuncs.com",
"Code": "BadRequest",
"Message": "The request has invalid parameters."
}