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

このトピックでは、共通のリクエストおよびレスポンスパラメーターについて説明します。

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

次の表に、Apsara File Storage NASのAPI操作をURLで呼び出すときに適用される一般的なリクエストパラメーターを示します。

パラメーター	データ型	必須	説明
Format	String	任意	レスポンスを返す形式を設定します。有効な値: JSONおよびXML。デフォルト値: JSON。
Version	String	はい	API のバージョン番号です。フォーマットはYYYY-MM-DDです。現在のバージョン番号は2017-06-26です。
AccessKeyId	String	はい	AccessKey ID。 AccessKeyペアはAPI操作の呼び出しに使用され、ユーザー名とパスワードのペアはNASコンソールへのログインに使用されます。
Signature	String	はい	署名文字列。詳細は、「署名要求」をご参照ください。
SignatureMethod	String	はい	署名文字列の暗号化方式を設定します。値を HMAC-SHA1 に設定します。
Timestamp	String	はい	リクエストのタイムスタンプです。 ISO 8601規格の時刻をyyyy-MM-ddTHH:mm:ssZ形式で指定します。時刻は UTC である必要があります。たとえば、2018-01-01T12:00:00Zは、2018年1月1日の20:00:00 (UTC + 8) を示します。
SignatureVersion	String	はい	署名暗号化アルゴリズムのバージョンを設定します。値を 1.0 に設定します。
SecurityToken	String	任意	セキュリティトークン。このパラメーターは、セキュリティトークンがSTSによって提供される場合に必要です。
SignatureNonce	String	任意	ユニークな乱数。リプレイ攻撃を防ぐには、リクエストごとに異なる乱数を使用する必要があります。

リクエストの例

https://nas.cn-hangzhou.aliyuncs.com/?Action=<Action>
&Format=xml
&Version=2017-06-26
&AccessKeyId=key-test
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&Timestamp=2018-01-01T12:00:00Z
...

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

パラメーター	データ型	説明
RequestId	String	リクエストの ID。このパラメーターは、呼び出しが成功したかどうかに関係なく返されます。

レスポンスの例

XML 形式

<?xml version="1.0" encoding="UTF-8"?>
<Interface Name+Response>
  <!--Return Request Tag-->
  <RequestId> 6D9F62C5-BF52-447C-AA34-C77F7AFCCC12</RequestId>
  <!--Return Result Data-->
</Interface Name+Response>

JSON 形式

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