开发者社区 问答 正文

E-MapReduce API参考公共参数是什么?



公共请求参数


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

名称类型是否必须描述
FormatString返回值的类型,支持 JSON 与 XML,默认为XML。
VersionStringAPI版本号,为日期形式:YYYY-MM-DD,本版本对应为2016-04-08。
AccessKeyIdString阿里云颁发给用户的访问服务所用的密钥 ID。
SignatureString签名结果串,关于签名的计算方法,请参见签名机制。
SignatureMethodstring签名方式,目前支持 HMAC-SHA1。
TimestampString请求的时间戳。日期格式按照 ISO8601 标准表示,并需要使用 UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ;例如,2013-08-15T12:00:00Z(为北京时间2013年8月15日20点0分0秒)。
SignatureVersionString签名算法版本,目前版本是 1.0。
SignatureNonceString唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。

示例
  1. https://emr.aliyuncs.com/
  2. ?Format=json
  3. &Version=2016-04-08
  4. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &OwnerId=12345678
  10. &Timestamp=2014-10-10T12:00:00Z


公共返回参数


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

  • 成功结果
    XML 返回结果包括请求是否成功信息和具体的业务数据。示例如下:
    1. {
    2.   "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    3.   /* 返回结果数据 */
    4. }

  • 错误结果
    调用接口出错后,将不会返回结果数据。调用方可根据附表错误代码表来定位错误原因。当调用出错时,HTTP 请求返回一个 4xx 或 5xx 的 HTTP状态码,返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求 ID:RequestId 和一个您该次请求访问的站点ID:HostId。在调用方找不到错误原因,可以联系阿里云客服,并提供该 HostId 和 RequestId,以便尽快帮您解决问题。
    1. {
    2.   "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
    3.   "HostId": "emr.aliyuncs.com",
    4.   "Code": "UnsupportedOperation",
    5.   "Message": "The specified action is not supported."
    6. }

    公共错误码
    请参考 ECS公共错误码

展开
收起
nicenelly 2017-10-30 16:47:12 1613 分享 版权
阿里云 AI 助理回答

在阿里云的API调用中,公共请求参数是每个API接口调用时都必须包含的一组参数,它们对于确保请求的安全性、版本控制以及响应格式等方面至关重要。您提供的参数列表已经很详细了,我来为您简要解析一下这些参数的作用和如何使用它们:

  1. Format:此参数指定返回数据的格式,支持JSON和XML,默认为XML。例如,如果您希望以JSON格式接收响应,应添加Format=json到请求URL中。

  2. Version:指定了您正在使用的API版本号,通常遵循YYYY-MM-DD的格式。这有助于阿里云对不同版本的API进行管理和维护,同时也允许用户选择与自己系统兼容的最佳版本。示例中的版本号为2016-04-08

  3. AccessKeyId:这是阿里云分配给用户的唯一标识符,用于验证请求发起者的身份。确保在安全的环境下保管好您的AccessKey ID和Secret。

  4. Signature:签名结果串,通过将其他请求参数(不包括Signature本身)按照特定规则排序、编码后,结合AccessKey Secret使用HMAC-SHA1或其它指定算法计算得出,用于保证请求的完整性和来源可信。

  5. SignatureMethod:指定生成Signature所使用的签名算法,如HMAC-SHA1。这告诉服务器您是如何对请求进行签名的。

  6. Timestamp:请求的时间戳,采用UTC时间,并遵循ISO8601标准格式。它用来防止重放攻击,确保请求是新鲜的。

  7. SignatureVersion:签名算法版本,目前固定为1.0

  8. SignatureNonce:一个随机字符串,用于增加签名的唯一性,防止相同的请求被重复利用(即重放攻击)。每次请求都应该使用不同的随机值。

示例中的URL https://emr.aliyuncs.com/?Format=json 显示了如何调用阿里云Elastic MapReduce服务并请求以JSON格式返回数据。实际调用时,除了Format外,还需加入上述其他公共参数,并根据具体API要求加入业务参数,且所有参数需参与签名计算生成Signature。

记得在实际应用中,使用阿里云官方SDK或者手动实现签名过程,确保请求符合阿里云API的要求。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答