公共参数

公共参数分为公共请求参数和公共返回参数。

公共请求参数

名称

类型

是否必须

描述

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"
        /*返回结果数据*/
    }