全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 阿里云办公 培训与认证 物联网

公共参数

更新时间:2017-09-26 11:37:50   分享:   

公共请求参数是指每个接口都需要使用到的请求参数。

名称 类型 是否必须 描述
Format String 返回值的类型,支持JSON与XML。默认为XML
Version String API版本号,为日期形式:YYYY-MM-DD,本版本对应为2014-11-11
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥ID
Signature String 签名结果串,关于签名的计算方法,请参见签名机制
SignatureMethod String 签名方式,目前支持HMAC-SHA1
Timestamp String 请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。例如,2014-11-11T12:00:00Z(为北京时间2014年11月11日20点0分0秒)
SignatureVersion String 签名算法版本,目前版本是1.0
SignatureNonce String 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值
RegionId String 仅支持 cn-hangzhou
Action String 调用接口的名称,如“Shield”

示例

  1. https://jaq.aliyuncs.com/
  2. ?Format=XML&Version=2016-04-12
  3. &Action=Shield&AccessKeyId=keyId
  4. &Signature=5Ag6fYxyiVJbHfuJdQFZPDyso40=
  5. &SignatureMethod=HMAC-SHA1
  6. &Timestamp=2016-06-02T15:22:59Z
  7. &SignatureVersion=1.0
  8. &SignatureNonce=c8233541-94c5-4a9f-abcc-425c66b6cf75
  9. &RegionId=cn-hangzhou

公共返回参数

用户发送的每次接口调用请求,无论成功与否,系统都会返回errorCode,errorMsg给用户。

示例

JSON格式

  1. { " ErrorCode": "xxx",
  2. " ErrorMsg": 0,
  3. /* 返回结果数据 */ }

XML格式

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--结果的根结点--> <接口名称+Response>
  3. ……
  4. <ErrorCode>4C467B38-3910-447D-87BC-AC049166F216</ ErrorCode >
  5. <ErrorMsg>0</ ErrorMsg >
  6. <!--返回结果数据--> </接口名称+Response>
本文导读目录
本文导读目录
以上内容是否对您有帮助?