edit-icon download-icon

Returned results

最終更新日: Dec 13, 2018

APIサービスが呼び出された後に返されるデータ形式は統一されています。

  • 返されたHTTPステータスコードが2xxの場合、呼び出しが成功したことを示します。
  • 返されたHTTPステータスコードが4xxまたは5xxの場合、呼び出しが失敗したことを示します。

成功した呼び出しの場合、返されるデータは XML と JSON がサポートされています。リクエストを送信する際に、外部システムはパラメータで、返されるデータの形式 (デフォルトではXML) を指定できます。このドキュメントでは、返された結果の例は、ユーザーが見やすい形式で書かれています。実際に返される結果には、改行、インデントなどがありません。

成功結果

XML 形式

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!—Result Root Node-->
  3. <Interface Name+Response>
  4. <!—Return Request Tag-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  6. <!—Return Result Data-->
  7. </Interface Name+Response>

JSON 形式

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
  3. /* Return Result Data*/
  4. }

エラー結果

インタフェース呼び出しでエラーが発生すると、結果データは返されません。呼び出し側は、各インタフェースのエラーコードと共通エラーコードに基づいてエラーの原因を特定できます。

呼び出しでエラーが発生すると、HTTPリクエストに対して4xxまたは5xxのHTTPステータスコードが返されます。返されるメッセージ本文には、特定のエラーコードとエラーメッセージが含まれています。また、グローバルに一意の要求ID (RequestId) と、このリクエストでアクセスしたサイトのID (HostId) も含まれています。呼び出し元がエラーの原因を見つけることができない場合、Alibaba Cloudカスタマーサービスに連絡し、問題を可能な限り迅速に解決するためにHostIdとRequestIdを提供してください。

XML 形式

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Error>
  3. <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
  4. <HostId>dns.aliyuncs.com</HostId>
  5. <Code>DomainNotExist</Code>
  6. <Message>The domain name does not exist.</Message>
  7. </Error>

JSON 形式

  1. {
  2. "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
  3. "HostId": "dns.aliyuncs.com",
  4. "Code": "DomainNotExist",
  5. "Message": "The domain name does not exist."
  6. }