:返された結果

API サービスが呼び出された後、返されるデータは統一されたフォーマットになります。

返される HTTP ステータスコード 2xx は、呼び出しが成功したことを示します。

返される HTTP ステータスコード 4xx または 5xx は、呼び出しが失敗したことを示します。

成功した呼び出しから返されるデータのフォーマットは、主に XML と JSON です。外部システムは、リクエスト中にパラメーターを渡して、返されるデータのフォーマットを指定できます。XML がデフォルトのフォーマットです。

このドキュメントの例のフォーマットは、表示の便宜上調整されています。実際に返される結果には、改行、インデント、その他のレイアウトはありません。

成功した結果

XML の例

<?xml version="1.0" encoding="UTF-8"?> 
<!--結果ルートノード-->
<Interface name + Response>
    <!--リクエストタグを返す-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--結果データを返す-->
</Interface name + Response>

JSON の例

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* 結果データを返す */
}

エラー結果

インターフェイス呼び出しでエラーが発生した場合、結果データは返されません。各インターフェイスに対応するエラーコードと、「エラーコード」に記載されているパブリックエラーコードに基づいて、エラーの原因を特定できます。

呼び出しでエラーが発生した場合、4xx または 5xx の HTTP ステータスコードが返されます。返されるメッセージ本文には、特定のエラーコードとエラーメッセージが含まれています。メッセージ本文には、グローバルに一意な RequestId とリクエストされた HostId も含まれています。エラーの原因がわからない場合は、Alibaba Cloud カスタマーサービスに連絡し、HostId と RequestId を提供して、できるだけ早く問題を解決してください。

XML の例

<?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <HostId>dm.aliyuncs.com</HostId>
   <Code>InvalidTemplate.NotFound</Code>
   <Message>The specified template is not found.</Message>
</Error>

JSON の例

{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "HostId": "dm.aliyuncs.com",
    "Code": "InvalidTemplate.NotFound",
    "Message": "The specified template does not found."
}