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

共通リクエストパラメーターは、すべてのドメインの API リクエストに設定されている必要があります。

パラメーター

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

リクエストの例

https:// mongodb.aliyuncs.com/
? Format=json
&Version=2015-12-01
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2016-01-01T12:00:00Z

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

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

成功レスポンスの例

<? xml version="1.0" encoding="utf-8"? > 
<!--Result Root Node-->
<Interface Name+Response>
<!--The returned request tag-->
<RequestId>4C4fdsf38-3910-447D-87AD-AC078932216</RequestId>
<!--The returned result-->
</Interface Name+Response>

レスポンス

API のレスポンスは以下の形式です。
  • 返された HTTP ステータスコードが 2xx の場合、呼び出しは成功です。
  • 4xx または5xx の HTTP ステータスコードは、API 操作が正常に呼び出されなかったことを示しています。
レスポンスデータは JSON 形式または XML 形式のいずれかで返されます。 リクエストでレスポンスの形式を指定できます。 デフォルトのレスポンス形式は XML です。
注 本ドキュメントのレスポンス例は、可読性のために書式が整えられています。 実際の応答は、改行や字下げでフォーマットされていません。

成功レスポンス

XML 形式

レスポンスには、リクエストが成功したかどうかや特定のサービスデータなどの情報が含まれます。 以下に例を示します。

<? xml version="1.0" encoding="utf-8"? > 
<!--Result Root Node-->
<Interface Name+Response>
<!--The returned request tag-->
<RequestId>4C4fdsf38-3910-447D-87AD-AC078932216</RequestId>
<!--The returned result-->
</Operation Name+Response>

JSON 形式

{
"RequestId": "4C4fdsf38-3910-447D-87AD-AC078932216",
/*The returned result*/
}

エラー結果

操作呼び出し時にエラーが発生した場合、結果データは返されません。 呼び出し元では、エラーコードテーブルを使用して、エラーの原因を特定できます。 呼び出し中にエラーが発生した場合、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> mongodb.aliyuncs.com</HostId>
<Code> UnsupportedOperation </Code>
<Message>The specified action is not supported. </Message>
</Error>

JSON 形式

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