全部產品
Search
文件中心

ActionTrail:公用參數

更新時間:Jul 01, 2024

公用參數分為公用請求參數和公用返回參數。

公用請求參數

名稱

類型

是否必須

描述

Format

String

返回訊息的格式。取值:

  • JSON

  • XML(預設值)

Version

String

API版本號碼,格式為:YYYY-MM-DD。目前的版本為2017-12-04

AccessKeyId

String

存取金鑰ID。更多資訊,請參見建立AccessKey

Signature

String

訊息簽名。更多資訊,請參見簽名機制

SignatureMethod

String

簽名計算方式。目前支援HMAC-SHA1。

Timestamp

String

請求的時間戳記,為日期格式。使用UTC時間並按照ISO8601標準,格式為:YYYY-MM-DDThh:mm:ssZ。

例如:北京時間2013年01月10日20點00分00秒,表示為2013-01-10T12:00:00Z。

SignatureVersion

String

簽名演算法版本,目前版本是1.0。

SignatureNonce

String

唯一隨機數,用於防止網路重放攻擊。使用者在不同請求間要使用不同的隨機數值。

公用請求參數樣本如下:

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返回結果採用統一格式,調用成功返回的資料格式有XML和JSON兩種,可以在發送請求時指定返回的資料格式,預設為XML格式。每次介面調用,無論成功與否,系統都會返回一個唯一識別碼RequestId

  • 返回2xxHTTP狀態代碼表示調用成功。

  • 返回4xx5xxHTTP狀態代碼表示調用失敗。

公用返回參數樣本如下:

  • XML格式

    <?xml version="1.0" encoding="utf-8"?> 
        <!--結果的根結點-->
        <介面名稱+Response>
            <!--返回請求標籤-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!--返回結果資料-->
        </介面名稱+Response>                        
  • JSON格式

    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216"
        /*返回結果資料*/
    }