edit-icon download-icon

Return result

最終更新日: Dec 13, 2018

API が呼び出されると、統一された形式でデータが返されます。呼び出しに成功すると、HTTP ステータスコード 2xx が返されます。呼び出しに失敗すると、HTTP ステータスコード 4xx または 5xx が返されます。呼び出しに成功した場合に、返されるデータ形式は主に XML と JSON となります。リクエストが送信されると、外部システムはパラメーターを入力して、返されるデータの形式を指定できます。デフォルトの形式は XML です。本ドキュメントでは、便宜上、応答結果の例は体裁が整えられています。実際の応答結果には改行、インデントやその他のレイアウトはありません。

成功結果

XML の例

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!-結果のルート ノード-->
  3. <API 名 + Response>
  4. <!-Return request tag-->
  5. <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
  6. <!-応答結果-->
  7. </API 名+Response>

JSON の例

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* 応答結果 */
  3. }

失敗結果

API 呼び出しでエラーが報告された場合、結果データは戻されません。呼び出し元は、各 API に対応するエラーコードとエラーコードリストに基づいてエラーの原因を突き止めることができます。呼び出しでエラーが発生すると、 HTTP リクエストに対して HTTP ステータスコード 4xx または 5xx が返されます。返されたメッセージ本文には、特定のエラーコードおよびエラーメッセージが含まれます。メッセージ本体には、グローバルに一意のリクエスト ID(RequestId)およびリクエストされたホスト ID(HostId)も含まれます。エラーの原因を特定できない場合、呼び出し元は、チケットを起票し、HostId および RequestId が必要な旨をサポートセンターにお問い合わせください。できるだけ早く問題を解決できるよう支援します。

XML の例

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Error>
  3. <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
  4. <HostId>mts.cn-hangzhou.aliyuncs.com</HostId>
  5. <Code>UnsupportedOperation</Code>
  6. <Message>The specified action is not supported.</Message>
  7. </Error>

JSON の例

  1. {
  2. "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
  3. "HostId": "mts.cn-hangzhou.aliyuncs.com",
  4. "Code": "UnsupportedOperation",
  5. "Message": "The specified action is not supported."
  6. }