本文档列举了物联网平台API的公共请求参数和公共返回参数。

公共请求参数

公共请求参数是调用每个API时都需要使用的请求参数。

名称 类型 是否必需 描述
Format String 返回值的类型,支持JSONXML类型。默认为XML
Version String API版本号,为日期形式:YYYY-MM-DD,最新版本为2018-01-20 。每个接口可以存在多个版本。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥ID。
Signature String 签名结果串。
SignatureMethod String 签名方式,目前支持HMAC-SHA1
Timestamp String 请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为YYYY-MM-DDThh:mm:ssZ

例如,2016-01-04T12:00:00Z(为北京时间2016年01月04日20点0分0秒)

SignatureVersion String 签名算法版本。目前版本是1.0。
SignatureNonce String 唯一随机数。用于防止网络重放攻击。用户在不同请求中要使用不同的随机数值
RegionId String 设备所在地域(与控制台上的Region对应),如 cn-shanghai。

示例

https://iot.cn-shanghai.aliyuncs.com/
?Format=XML
&Version=2018-01-20
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=...
&Timestamp=2018-05-20T12:00:00Z
&RegionId=cn-shanghai

公共返回参数

API返回结果采用统一格式,返回2xx HTTP状态码代表调用成功;返回4xx或5xx HTTP状态码代表调用失败。调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式。默认为XML格式。

每次接口调用,无论成功与否,系统都会返回一个唯一识别码RequestId

  • 调用成功

    • XML格式

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

      {
          "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
          /* 返回结果数据 */
      }
  • 调用失败

    调用接口出错后,将不会返回结果数据。调用方可根据错误码来定位错误原因。

    当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外,还包含一个全局唯一的请求ID:RequestId。在您不能确认错误的情况下,可以联系阿里云客服,并提供该RequestId,以便我们尽快帮您解决问题。

    • XML格式

      <?xml version="1.0" encoding="UTF-8"?>
      <Error>
         <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
         <Code>UnsupportedOperation</Code>
         <Message>The specified action is not supported.</Message>
      </Error>
    • JSON格式

      <?xml version="1.0" encoding="UTF-8"?>
      <Error>
         <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
         <Code>UnsupportedOperation</Code>
         <Message>The specified action is not supported.</Message>
      </Error>