成功とエラーの API レスポンス構造 - Domain

応答は JSON 形式または XML 形式で返されます。リクエスト時に応答形式を指定できます。デフォルトの応答形式は XML です。本トピックでは、API 呼び出し成功時および失敗時のサンプル応答を示します。

API の応答は HTTP 応答形式を採用しており、ステータスコードが 2xx の場合は呼び出しが成功したことを示し、4xx または 5xx の場合は呼び出しが失敗したことを示します。

説明本トピックに掲載するサンプル応答は、視認性向上のため整形されています。実際の応答には改行やインデントは含まれません。

成功時の応答サンプル

XML 形式

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

JSON 形式

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* 応答データ */
}

エラー発生時の応答サンプル

API 呼び出し中にエラーが発生した場合、システムからは応答が返されません。エラーコードおよび一般的なエラーコードを参照してトラブルシューティングを行ってください。

呼び出し中にエラーが発生すると、HTTP ステータスコードとして 4xx または 5xx が返されます。返されるメッセージ本文には、特定のエラーコードおよびエラーメッセージが含まれます。また、本文には RequestId および HostId パラメーターも含まれます。RequestId パラメーターはリクエストのグローバル一意識別子 (GUID) を示し、HostId パラメーターはリクエストでアクセスしたサイトの ID を示します。

エラーの原因が特定できない場合は、Alibaba Cloud カスタマーサービスまでご連絡ください。迅速な対応のため、HostId および RequestId を併記してお知らせください。

XML 形式

<? xml version="1.0" encoding="UTF-8"? >
<Error>
    <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
    <HostId>domain-intl.aliyuncs.com</HostId>
    <Code>DomainNotExist</Code>
    <Message>ドメイン名が存在しません。</Message>
</Error>

JSON 形式

{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "HostId": "domain-intl.aliyuncs.com",
    "Code": "DomainNotExist",
    "Message": "ドメイン名が存在しません。"
}