全部产品
专有网络 VPC

公共参数

更新时间:2017-06-07 13:26:11   分享:   

公共请求参数

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

名称 类型 是否必须 描述
Format String 返回值的类型,支持 JSON 与 XML。默认为 XML。
Version String API 版本号,为日期形式:YYYY-MM-DD,本版本对应为 2016-04-28。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥 ID。
Signature String 签名结果串,关于签名的计算方法,请参见<签名机制>。
SignatureMethod String 签名方式,目前支持 HMAC-SHA1。
Timestamp String 请求的时间戳。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:
YYYY-MM-DDThh:mm:ssZ
例如,2014-05-26T12:00:00Z(为北京时间 2014 年 5 月 26 日 20 点 0 分 0 秒)。
SignatureVersion String 签名算法版本,目前版本是 1.0。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值
ResourceOwnerAccount String 本次 API 请求访问到的资源拥有者账户,即登录用户名。
此参数的使用方法,详见< 借助 RAM 实现子账号对主账号的 VPC 资源访问 >,(只能在 RAM 中可对 VPC 资源进行授权的 Action 中才能使用此参数,否则访问会被拒绝)

示例

  1. https://vpc.aliyuncs.com/
  2. ?Format=xml
  3. &Version=2016-04-28
  4. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &Timestamp=2016-06-01T12:00:00Z

公共返回参数

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

示例

XML示例:

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

JSON示例:

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  3. /* 返回结果数据 */
  4. }
本文导读目录
本文导读目录
以上内容是否对您有帮助?