This topic describes the common request parameters and common response parameters in Apsara File Storage NAS API.

Common request parameters

The following table lists the common request parameters that must be included in all NAS API requests.

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 of the API. The API version is represented as a date in the YYYY-MM-DD format. The current API version is 2017-06-26.
AccessKeyId String Yes The AccessKey ID that is assigned to you by Alibaba Cloud.
Signature String Yes The signature string of the current request.
SignatureMethod String Yes The encryption method of the signature string. Set the value to HMAC-SHA1.
Timestamp String Yes The timestamp of the request, for example, 2017-05-26T12:00:00Z. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.
SignatureVersion String Yes The version of the signature encryption algorithm. Set the value to 1.0.
SecurityToken String No The STS token. This parameter is required when the Security Token Service (STS) is used.
SignatureNonce String No A unique, random number that is used to prevent replay attacks. You must use different numbers for different requests.

Sample requests

GET https://nas.cn-hangzhou.aliyuncs.com/?Action=<Action>
&Format=xml
&Version=2017-06-26
&AccessKeyId=key-test
&Signature=Pc5***3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&Timestamp=2012-06-01T12:00:00Z
...
			

Common response parameters

Every response returns a unique RequestId regardless of whether the call is successful.

Parameter Type Description
RequestId Integer The unique ID of the request.

Sample responses

  • XML format

    <? xml version="1.0" encoding="UTF-8"? >
    <API Operation Name+Response>
      <! --Return Request Tag-->
      <RequestId> 6D9F62C5-BF52-447C-AA34-C77F7AFCCC12</RequestId>
      <! --Return Result Data-->
    </API Operation Name+Response>
    					
  • JSON format

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