RPC API公共参数

更新时间:2018-03-02 11:55:23

公共请求参数

除API特定的参数外,每次调用API时,都需要提供下表中的公共请求参数。

参数 类型 是否必须 描述
Version String

API版本号,日期形式为:YYYY-MM-DD。

比如:2014-05-26。

注意:各产品的API版本号都不同,具体API版本参见具体的API文档。

AccessKeyId String

阿里云颁发给用户的访问服务所用的AccessKey ID。

注意:为了提高账号的安全,建议您使用RAM账号的AccessKey。

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账户访问主账户中的云资源时需要指定本参数。不同的云产品对RAM账户访问主帐号时有不同的鉴权规则。详情参见该产品的开发指南。

Format String

返回响应的格式,取值:

JSON | XML (默认值)

公共返回参数

无论成功与否,都会返回一个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. }