推特 阿里云技术文档正文

公共参数_调用方式_API手册_智能云相册

admin 阿里云技术文档 2020-02-11 211 0
阿里云服务器优惠

公共参数

公共请求参数

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

名称 类型 必填项 描述
Format String 返回值的类型,支持JSON与XML,默认为XML。
Version String API版本号,为日期形式:YYYY-MM-DD,本版本对应为2017-07-11。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥ID,或者从您的业务服务器获取到的临时访问凭证中的临时密钥ID。
Signature String 签名结果串,关于签名的计算方法,请参见签名机制。
SignatureMethod String 签名方式,目前支持HMAC-SHA1。
Timestamp String 请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
例如,2014-7-29T12:00:00Z(为北京时间2014年7月29日的20点0分0秒。
SignatureVersion String 签名算法版本,目前版本是1.0。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。
SecurityToken String 是(特定情况) STS凭证,如果客户端从业务服务器获取STS凭证后访问智能云相册服务,该参数为必选。
LibraryId String 是(特定情况) 照片库的Id,如果使用AK认证的方式来对照片库进行操作,该参数为必选。如果使用STS认证的方式,LibraryId是通过SecurityToken中的RoleSessionName来进行传递,此时该参数为可选,如果提供了该参数,那么其值需要和RoleSessionName一致。

示例:

  1. http://cloudphoto.cn-shanghai.aliyuncs.com/
  2. ?Format=json
  3. &Version=2017-07-11
  4. &Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D
  5. &SignatureMethod=Hmac-SHA1
  6. &SignatureNonce=9166ab59-f445-4005-911d-664c1570df0f
  7. &SignatureVersion=1.0
  8. &Action=ListPhotos
  9. &AccessKeyId=tkHh5O7431CgWayx
  10. &Timestamp=2017-07-29T09%3A22%3A32Z
  11. &SecurityToken=<SecurityTokenFromBusinessServer>

公共返回参数

用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId给用户。

XML示例:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!—结果的根结点-->
  3. <接口名称+Response> <!—返回请求标签-->
  4. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  5. <!—返回结果数据-->
  6. </接口名称+Response>

Json示例:

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* 返回结果数据 */
  3. }

注意:文档中的返回示例为了便于阅读,做了格式化处理,实际返回结果是没有进行换行、缩进等处理。

版权声明

本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。

评论

-----