This topic describes common parameters, including common request parameters and common response parameters.

Common request parameters

Common request parameters must be included in all ActionTrail API requests.

Parameter Type Required Description
Format String No The format in which to return the response. Set the value to JSON.
Version String Yes The version number of the API, in the YYYY-MM-DD format. Set the value to 2017-12-04.
AccessKeyId String Yes The AccessKey ID provided to you by Alibaba Cloud for authentication.
Signature String Yes The signature string of the current request. For more information about how signatures are calculated, see Signature method.
SignatureMethod String Yes The encryption method of the signature string. Set the value to HMAC-SHA1.
Timestamp String Yes The timestamp of the request. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. Example: 2014-05-26T12:00:00Z.
SignatureVersion String Yes The version of the signature encryption algorithm. Set the value to 1.0.
SignatureNonce String Yes A unique, random number used to prevent replay attacks. You must use different numbers for different requests.

Sample request

http://actiontrail.cn-hangzhou.aliyuncs.com/actiontrail
? 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=            

Common response parameters

When you send an API request, the system returns the result if the API operation is successfully called, and returns RequestId if the API operation fails to be called. Responses can be returned only in the JSON format.

Sample response

JSON format

{
  "Name": "CreateTest",
  "OssBucketName": "yuanch****",
  "OssKeyPrefix": "",
  "RoleName": "aliyunactiontraildefaultrole"
}