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

共通リクエストパラメーター

共通リクエストパラメーターは、すべてのApsaraDB for MongoDB APIリクエストに含める必要があります。

共通リクエストパラメーター

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

リクエストの例

https:// mongodb.aliyuncs.com/?Action=<API名>
? 形式=json
&バージョン=2015-12-01
&シグネチャー=Pc5WB8gokVn0xfeu % 2FZV % 2BiNM1dgI % 3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=キーテスト
&タイムスタンプ=2016-01-01T12:00:00Z

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

操作を呼び出すと、システムは、リクエストが成功したかどうかにかかわらず、RequestId パラメーターによりリクエストのグローバル一意識別子 (GUID) を返します。

レスポンスの例

<?xml version="1.0" encoding="utf-8"?>
<!-- 結果ルートノード -->
<インターフェイス名 + レスポンス>
<!-- Return Request Tag -->
<RequestId>4C4fdsf38-3910-447D-87AD-AC078932216</RequestId>
<!-- 結果データを返す -->
</インタフェース名 + 応答>

返された結果

APIレスポンスは、HTTPレスポンス形式を使用します。

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

レスポンスデータは JSON 形式または XML 形式のいずれかで返されます。リクエストでレスポンスの形式を指定できます。デフォルトのレスポンス形式は XML です。

説明このセクションの応答例は、明確なビューのために改行またはインデントでフォーマットされています。実際の応答は、これらの例として適切にフォーマットされない。

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

XML形式

XML形式の応答には、要求の結果と操作の詳細が含まれます。例：

<?xml version="1.0" encoding="utf-8"?>
<!-- 結果ルートノード -->
<インターフェイス名 + レスポンス>
<!-- Return Request Tag -->
<RequestId>4C4fdsf38-3910-447D-87AD-AC078932216</RequestId>
<!-- 結果データを返す -->
</インタフェース名 + 応答>

JSON形式

{
"RequestId": "4C4fdsf38-3910-447D-87AD-AC078932216" 、/* 結果データを返す * /
}

エラーレスポンスの例

API操作の呼び出し時にエラーが発生した場合、結果データは返されません。付録のエラーコードを参照して、エラーの原因を特定できます。 API操作の呼び出し時にエラーが発生した場合、4XXまたは5XX HTTPステータスコードが返されます。返されるメッセージの本文に具体的なエラーコードとエラーメッセージが含まれています。グローバルに一意のリクエストID (RequestId) 、およびこのリクエストでアクセスしたサイトのID (HostId) 。

エラーの原因を特定できない場合、Alibaba Cloud カスタマーサービスにHostId と RequestId をご連絡ください。

XML形式

<?xml version="1.0" encoding="UTF-8"?>
<エラー>
<RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
<HostId> mongodb.aliyuncs.com</HostId>
<Code>UnsupportedOperation</Code>
<Message> 指定されたアクションはサポートされていません。</Message>
</エラー>

JSON形式

{
"RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF" 、"HostId": "mongodb.aliyuncs.com" 、"コード": "UnsupportedOperation" 、"Message": "指定されたアクションはサポートされていません。}