すべてのプロダクト
Search
ドキュメントセンター

ActionTrail:共通パラメーター

最終更新日:Jan 17, 2025

共通パラメーターには、共通リクエストパラメーターと共通レスポンスパラメーターが含まれます。

共通パラメーターの例

パラメータータイプ必須説明
FormatStringいいえレスポンスを返す形式。有効な値:
  • JSON
  • XML(デフォルト値)
VersionStringはいAPI のバージョン番号。バージョン番号は YYYY-MM-DD 形式です。2017-12-04 に設定します。
AccessKeyIdStringはいAlibaba Cloud から提供された AccessKey ID。詳細については、「AccessKey を作成する」をご参照ください。
SignatureStringはい現在のリクエストの署名文字列。署名の計算方法の詳細については、「リクエスト署名」をご参照ください。
SignatureMethodStringはい署名文字列の暗号化方式。値を HMAC-SHA1 に設定します。
TimestampStringはいリクエストのタイムスタンプ。リクエストのタイムスタンプ。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時間を指定します。時間は UTC でなければなりません。

たとえば、2013 年 1 月 10 日 20:00:00(UTC + 08:00)を指定するには、値を 2013-01-10T12:00:00Z に設定します。

SignatureVersionStringはい署名暗号化アルゴリズムのバージョン。値を 1.0 に設定します。
SignatureNonceStringはいリプレイ攻撃を防ぐために使用される一意の乱数。リクエストごとに異なる番号を使用する必要があります。
リクエストの例
http://actiontrail.cn-hangzhou.aliyuncs.com
?SignatureVersion=1.0
&OssBucketName=yuanch****
&Name=CreateTest
&Format=JSON
&Timestamp=2015-12-01T07%3A04%3****
&Signature=iyEsE7vgGUWop7Term5HM48wzJ****
&AccessKeyId=QzW2********C21M
&SignatureMethod=HMAC-SHA1
&Version=2017-12-04
&RoleName=aliyunactiontraildefaultrole
&Action=CreateTrail
&SignatureNonce=c69b30de-97f9-11e5-afb0-7831c1c8****
&OssKeyPrefix=            

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

API レスポンスは HTTP レスポンス形式を使用します。レスポンスは JSON または XML 形式で返されます。リクエストでレスポンス形式を指定できます。デフォルトのレスポンス形式は XML です。すべてのレスポンスは、呼び出しが成功したかどうかに関係なく、一意の RequestId を返します。
  • 2xx HTTP ステータスコードは、呼び出しが成功したことを示します。
  • 4xx または 5xx HTTP ステータスコードは、呼び出しが失敗したことを示します。
レスポンスの例
  • XML 形式
    <?xml version="1.0" encoding="utf-8"?> 
        <!--Result Root Node-->
        <Interface Name+Response>
            <!--Return Request Tag-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!--Return Result Data-->
        </Interface Name+Response>                        
  • JSON 形式
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216"
        /*Return Result Data*/
    }