edit-icon download-icon

レスポンス構造

最終更新日: May 24, 2019

API が返す全てのデータは、次の形式を使用します。

  • HTTP ステータスコード 2xx が返された場合、リクエストは成功です。
  • HTTP ステータスコード 4xx が返された場合、リクエストは失敗です。

リクエストが成功した場合の戻り値は、JSON 形式でエンコードされます。

成功したリクエストの戻り値

JSON の例:

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  3. /* Returned data */
  4. }

失敗したリクエストの戻り値

リクエストが失敗した場合、HTTP ステータスコード 4xx または 5xx の HTTP レスポンスが返されます。レスポンスのボディには、エラーコードとエラー情報が含まれています。エラーコードを元に原因を調べることができます。レスポンスには、システム全体で一意のリクエスト ID (RequestId) と、アクセスしたサーバーの ID (HostId) も含まれています。原因不明の場合は、チケットを起票し、サポートセンターへお問い合わせください。問題の解決には、要求に応じて HostId と RequestId を提出してください。

JSON の例:

  1. {
  2. "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
  3. "HostId": "imagesearch.aliyuncs.com",
  4. "Code": "BadRequest",
  5. "Message": "The request has invalid parameters."
  6. }