共通リクエストパラメーターと共通レスポンスパラメーターから構成される共通パラメーターは、すべての API 操作で必要なものです。
共通リクエストパラメーター
次の表は、すべての API リクエストで必要な、一般的なリクエストパラメーターを示しています。
パラメーター | データ型 | 必須 / 任意 | 説明 |
---|---|---|---|
Format | String | 任意 | レスポンスの形式。 有効な値:JSON および XML。 デフォルト値:JSON。 |
Version | String | 必須 | API バージョン (YYYY-MM-DD 形式)。 現在のバージョンは 2017-08-01 です。 |
AccessKeyId | String | 必須 | Alibaba Cloud から提供された AccessKey ID。 |
Signature | String | 必須 | 計算された署名文字列。 署名の計算方法については、「署名のしくみ」をご参照ください。 |
SignatureMethod | String | 必須 | 署名アルゴリズム。 現在は、HMAC-SHA1 のみに対応しています。 |
Timestamp | String | 必須 | リクエストのタイムスタンプ。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ ) の形式で指定します。 タイムゾーンは UTC です。 たとえば、値 2013-08-15T12:00:00Z は 2013 年 8 月 15 日、UTC+8 で 20:00:00 を示します。
|
SignatureVersion | String | 必須 | 署名アルゴリズムのバージョン。 現在のバージョンは 1.0 です。 |
SignatureNonce | String | 必須 | リプレイ攻撃防止に使用する一意の乱数。 リクエストごとに異なる乱数を使用する必要があります。 |
共通レスポンスパラメーター
システムは、リクエストの結果に関係なく、各 API リクエストに対して一意の ID (RequestId) を返します。
リクエストの例
https://rds.aliyuncs.com/
? Format=xml
&Version=2014-08-15
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2014-10-10T12:00:00Z
レスポンスの例
API リクエストを送信すると、システムは統一形式でレスポンスを返します。 HTTP ステータスコード 2xx が返された場合、呼び出しが成功したことを示します。 HTTP ステータスコード 4xx または 5xx が返された場合、呼び出しが失敗したことを示します。 システムは、XML 形式または JSON 形式で正常なレスポンスを返します。 リクエストパラメーターでレスポンスの形式を指定できます。 デフォルトの形式は XML です。 API リファレンス内では読みやすくするために、すべてのサンプルレスポンスの行が折り返され、インデントされています。 実際のレスポンスでは、行はフォーマットされません。
<? xml version="1.0" encoding="utf-8"? >
<!—Result root node-->
<Operation+Response>
<!—Tag of the response to the request-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!—Result data-->
</Operation+Response>
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
/* Result data */
}
API 操作中にエラーが発生した場合、システムは結果データを返しません。 クライアントエラーコードに従ってエラーの原因を特定します。
HTTP リクエストを送信すると、システムは HTTP ステータスコード 4xx または 5xx を返してエラーが発生したことを示します。 返されるレスポンスの本文には、エラーコードとエラーメッセージが含まれています。 また、グローバルに一意なリクエスト ID (RequestId) とリクエスト先のホスト ID (HostId) も含まれています。 エラーの原因を特定できない場合は、Alibaba Cloud サポートセンターにお問い合わせください。返された HostId および RequestId をご提供いただくと、エラーを解決しやすくなります。
<? xml version="1.0" encoding="UTF-8"? >
<Error>
<RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
<HostId>rds.aliyuncs.com</HostId>
<Code> UnsupportedOperation </Code>
<Message>The specified action is not supported. </Message>
</Error>
{
"RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
"HostId": "rds.aliyuncs.com",
"Code": "UnsupportedOperation",
"Message": "The specified action is not supported."
}