物联网无线连接服务API的公共参数有哪些_物联网无线连接服务(IoTMCP)-阿里云帮助中心

本文档介绍物联网无线连接服务API的公共请求参数和公共返回参数。

公共请求参数

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

名称	类型	是否必需	描述
Format	String	否	返回消息的格式。取值： JSON XML（默认值）
Version	String	是	API版本号，使用YYYY-MM-DD日期格式。最新版本为：2021-05-20。
AccessKeyId	String	是	访问密钥ID。登录阿里云控制台，将鼠标移动至账号头像上，然后单击AccessKey管理，跳转至访问凭证管理页面，即可创建和查看AccessKeyId。
Signature	String	是	消息签名。更多信息，请参见签名机制。
SignatureMethod	String	是	签名方式。取值：HMAC-SHA1。
SignatureNonce	String	是	唯一随机数。用于防止网络重放攻击。在不同请求间要使用不同的随机数值。
SignatureVersion	String	是	签名算法版本。取值：1.0。
Timestamp	String	是	请求的时间戳，为日期格式。使用UTC时间并按照ISO8601标准，格式为：YYYY-MM-DDThh:mm:ssZ。例如：北京时间2013年01月10日20点00分00秒，表示为2013-01-10T12:00:00Z。

公共请求参数示例如下：

https://linkcard.aliyuncs.com/
?Format=XML
&Version=2021-05-20
&Signature=Pc5WB***
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=234***
&Timestamp=2018-05-20T12:00:00Z

公共返回参数

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）。

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格式

{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}