API が呼び出されると、統一された形式でデータが返されます。呼び出しに成功すると、HTTP ステータスコード 2xx が返されます。呼び出しに失敗すると、HTTP ステータスコード 4xx または 5xx が返されます。呼び出しに成功した場合に、返されるデータ形式は主に XML と JSON となります。リクエストが送信されると、外部システムはパラメーターを入力して、返されるデータの形式を指定できます。デフォルトの形式は XML です。本ドキュメントでは、便宜上、応答結果の例は体裁が整えられています。実際の応答結果には改行、インデントやその他のレイアウトはありません。
XML の例
<?xml version="1.0" encoding="UTF-8" ?>
<!-結果のルート ノード-->
<API 名 + Response>
<!-Return request tag-->
<RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
<!-応答結果-->
</API 名+Response>
JSON の例
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* 応答結果 */
}
失敗結果
API 呼び出しでエラーが報告された場合、結果データは戻されません。呼び出し元は、各 API に対応するエラーコードとエラーコードリストに基づいてエラーの原因を突き止めることができます。呼び出しでエラーが発生すると、 HTTP リクエストに対して HTTP ステータスコード 4xx または 5xx が返されます。返されたメッセージ本文には、特定のエラーコードおよびエラーメッセージが含まれます。メッセージ本体には、グローバルに一意のリクエスト ID(RequestId)およびリクエストされたホスト ID(HostId)も含まれます。エラーの原因を特定できない場合、呼び出し元は、チケットを起票し、HostId および RequestId が必要な旨をサポートセンターにお問い合わせください。できるだけ早く問題を解決できるよう支援します。
XML の例
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
<HostId>mts.cn-hangzhou.aliyuncs.com</HostId>
<Code>UnsupportedOperation</Code>
<Message>The specified action is not supported.</Message>
</Error>
JSON の例
{
"RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
"HostId": "mts.cn-hangzhou.aliyuncs.com",
"Code": "UnsupportedOperation",
"Message": "The specified action is not supported."
}