APIを呼び出した後、データは一様な形式で返されます。 返されたHTTPステータスコードが2xxである場合、呼び出しは成功です。 返されたHTTPステータスコードが4xx、或いは5xxの場合、呼び出しは失敗です。 呼び出しが成功した場合、データは主にXMLとJSONの 2 種類の形式で返されます。 リクエストの送信時に、外部システムはパラメータで返されるデータの形式を指定できます。 デフォルト形式はXMLです。 本ドキュメントでは、返された結果の例を読みやすい形式で表示しています。 実際の結果は、改行やインデントなどで体裁が整えられているわけではありません。
成功時の結果
- XMLの例XML 形式で返された結果には、リクエストが成功したかどうかを示すメッセージと、特定のサービスデータが含まれます。 次に例を示します:
<? xml version="1.0" encoding="utf-8"? > <!—Result root node--> <interface name+Response> <!—return request result--> <RequestId> </RequestId> <!—Return result data--> </Interface name + response>
- JSON の例
{ "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* return result result */ }
エラー時の結果
インターフェイス呼び出しでエラーが発生すると、結果が返されません。 エラーの原因は、添付の付録の「エラーコード表」で確認できます。
呼び出しでエラーが発生すると、HTTPリクエストに対して4xxまたは5xxという形式のHTTPステータスコードが返されます。 戻り値のメッセージ本文には、固有のエラーコードとエラーメッセージが含まれています。 また、メッセージ本文には、全体でユニークな「RequestId」と、リクエストした「HostId」も含まれています。 エラーの原因を特定できない場合は、Alibabaクラウドカスタマーサービスにご連絡ください。その際、よりスムーズに問題を解決できるよう「HostId」と「RequestId」をご提示ください。
- XML形式の例
<? xml version="1.0" encoding="UTF-8"? > <Error> <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId> <HostId>sts.aliyuncs.com</HostId> <Code>InvalidParameter</Code> <Message>The specified parameter "Action or Version" is not valid.</Message> </Error>
- JSON形式の例
{ "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF", "HostId": "sts.aliyuncs.com", "Code": "InvalidParameter", "Message": "The specified parameter \"Action or Version\" is not valid." }