This topic describes the common request and response parameters.

Common request parameters

The following table describes the common request parameters that apply when you call the API operations of Apsara File Storage NAS over URLs.

Parameter Type Required Description
Format String No The format in which to return the response. Valid values: JSON and XML. Default value: JSON.
Version String Yes The version number of the API. The format is the YYYY-MM-DD. The current version number is 2017-06-26.
AccessKeyId String Yes The AccessKey ID. An AccessKey pair is used to call API operations, and a pair of username and password is used to log on to the NAS console.
Signature String Yes The signature string. For more information, see Request signatures.
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.

For example, 2018-01-01T12:00:00Z indicates 20:00:00 on January 1, 2018 (UTC+8).

SignatureVersion String Yes The version of the signature encryption algorithm. Set the value to 1.0.
SecurityToken String No The security token. This parameter is required if the security token is provided by STS.
SignatureNonce String No A unique, random number. To prevent replay attacks, you must use different random numbers for different requests.

Sample requests

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
...

Common response parameters

Parameter Type Description
RequestId String The ID of the request. This parameter is returned regardless of whether the call is successful.

Sample responses

  • XML format

    <?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 format

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