本文介绍了文件存储NAS的公共请求参数和公共返回参数的详细说明。
公共请求参数
NAS的RESTful接口中使用了一些公共请求参数。这些请求参数可以被所有的NAS请求所使用,其详细定义如下。
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Format | String | 否 | 返回值的类型,支持JSON与XML。默认为JSON。 |
Version | String | 是 | API版本号为日期形式:YYYY-MM-DD,本版本为2017-06-26。 |
AccessKeyId | String | 是 | 阿里云颁发给用户的访问服务所用的密钥ID。 |
Signature | String | 是 | 签名结果串。 |
SignatureMethod | String | 是 | 签名方式,目前支持HMAC-SHA1。 |
Timestamp | String | 是 | 请求的时间戳。日期格式按照ISO8601标准表示,使用UTC时间,具体为YYYY-MM-DDThh:mm:ssZ。例如,2017-05-26T12:00:00Z。 |
SignatureVersion | String | 是 | 签名算法版本,目前版本是1.0。 |
SecurityToken | String | 否 | 使用STS凭证类型时,要求传入。 |
SignatureNonce | String | 否 | 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。 |
请求示例
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
…
公共返回参数
您每次发送的接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId
给您。
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | Integer | 系统返回的唯一识别码。 |
返回示例
-
XML示例
<?xml version="1.0" encoding="UTF-8"?> <接口名称+Response> <!--返回请求标签--> <RequestId> 6D9F62C5-BF52-447C-AA34-C77F7AFCCC12</RequestId> <!--返回结果数据--> </接口名称+Response>
-
JSON示例
{ "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* 返回结果数据 */ }