共通パラメーター - Data Transmission Service - Alibaba Cloud ドキュメントセンター

このトピックでは、共通リクエストパラメーターと共通レスポンスパラメーターを含む共通パラメーターについて説明します。すべてのAPIリクエストで共通のパラメーターが必要です。

サンプル共通パラメータ

パラメーター	タイプ	必須	説明
Format	String	任意	レスポンスを返す形式を設定します。有効な値 : JSON と XML。デフォルト値：XML。
Version	String	必須	API バージョン番号を日付形式 YYYY-MM-DD で示します。現在のバージョン番号は2020-01-01です。
AccessKeyID	String	必須	Alibaba Cloud から提供された AccessKey ID です。
Signature	String	必須	現在のリクエストの署名文字列。
SignatureMethod	String	必須	署名文字列の暗号化方式を設定します。値を HMAC-SHA1 に設定します。
Timestamp	String	必須	リクエストのタイムスタンプです。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。時刻は UTC である必要があります。
SignatureVersion	String	必須	署名暗号化アルゴリズムのバージョンを設定します。値を 1.0 に設定します。
SignatureNonce	String	必須	リプレイ攻撃を防ぐために使用される一意の乱数。各リクエストで異なる乱数を使用する必要があります。

共通レスポンスパラメーター

すべての応答は、呼び出しが成功したかどうかに関係なく、一意のリクエストIDを返します。

レスポンスの例

DTS APIは、標準のHTTPステータスコードを使用して、呼び出しが成功したかどうかを示します。

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

応答はJSONまたはXML形式で返すことができます。リクエストでレスポンスの形式を指定できます。デフォルトのレスポンス形式は XML です。読み取りを容易にするために、サンプル応答はフォーマットされる。実際の応答には、改行やインデントは含まれません。

正常に処理された場合のレスポンス例

XML形式

<? xml version="1.0" encoding="utf-8"? > 
<!--Result Root Node-->
<Operation Name + Response>
    <!--Return Request Tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--Return Result Data-->
</Operation Name + Response>

JSON形式

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /*Return Result Data*/
}

エラーレスポンスの例

HTTP リクエストを送信すると、システムは HTTP ステータスコード 4xx または 5xx を返してエラーが発生したことを示します。返されるレスポンスの本文には、エラーコードとエラーメッセージが含まれています。レスポンス本文には、グローバルに一意なリクエストIDを示すRequestIdパラメーターと、リクエストしたサイトのIDを示すHostIdパラメーターも含まれます。

説明

エラーコードに基づいてエラーをトラブルシューティングできます。詳細については、エラーコードをご参照ください。エラーの原因を特定できない場合は、Alibaba Cloud サポートセンターにお問い合わせください。返された HostId および RequestId をご提供いただくと、エラーを解決しやすくなります。

XML形式

<? xml version="1.0" encoding="UTF-8"? >
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <HostId>dts.aliyuncs.com</HostId>
   <Code>UnsupportedOperation</Code>
   <Message>The specified action is not supported. </Message>
</Error>

JSON形式

{
    "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
    "HostId": "dts.aliyuncs.com",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}