公共参数 - - 阿里云

本文介绍每个接口都需要使用的请求参数和返回参数。

公共请求参数

表 1. 公共请求参数表
名称	类型	是否必须	描述
Format	String	否	返回消息的格式。取值： JSON XML
Version	String	是	API版本号，使用YYYY-MM-DD日期格式。取值： 2020-04-20
AccessKeyId	String	是	访问服务使用的密钥ID，即您的阿里云账号的AccessKey ID，获取方式，请参见获取AccessKey。
Signature	String	是	签名结果串。具体构造方法，请参见签名机制。
SignatureMethod	String	是	签名方式，取值： HMAC-SHA1
Timestamp	String	是	请求的时间戳，为日期格式。使用UTC时间按照ISO8601标准，格式为YYYY-MM-DDThh:mm:ssZ。例如，北京时间2013年01月10日20点0分0秒，表示为2013-01-10T12:00:00Z。
SignatureVersion	String	是	签名算法版本，取值： 1.0
SignatureNonce	String	是	唯一随机数，用于防止网络重放攻击。在不同请求间要使用不同的随机数值。
ResourceOwnerAccount	String	否	本次API请求访问到的资源拥有者账户，即登录用户名。

公共请求参数示例

http://onsmqtt.[regionId].aliyuncs.com/?Action=[ApiName]
&TimeStamp=2020-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE****
&Version=2020-04-20
&SignatureVersion=1.0
&Signature=[Signature]

公共返回参数

API返回结果采用统一格式，调用成功返回的数据格式有XML和JSON两种，可以在发送请求时指定返回的数据格式，默认为XML格式。每次接口调用，无论成功与否，系统都会返回一个唯一识别码RequestId。

返回2xxHTTP状态码表示调用成功。
返回4xx或5xxHTTP状态码表示调用失败。

公共正常返回参数示例

接口调用成功后会返回接口返回参数和请求ID，这样的返回是正常返回。HTTP状态码为2xx。

XML格式

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

JSON格式

{
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*返回结果数据*/
    }

异常返回示例XML格式

接口调用出错后，会返回错误码、错误信息和请求ID，这样的返回是异常返回。HTTP状态码为4xx或者5xx。您可以根据接口错误码，参见错误码列表排查问题。当您无法排查出具体问题时，请联系云消息队列 MQTT 版技术支持，钉钉群号：35228338。

XML示例

<?xml version="1.0" encoding="UTF-8"?><!--结果的根结点-->
<Error>
    <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!--请求ID-->
    <Code>MissingParameter.CommandId</Code> <!--错误码-->
    <Message>The input parameter “CommandId” that is mandatory for processing this request is not supplied.</Message> <!--错误信息-->
</Error>

JSON示例

{
    "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* 请求ID */
    "Code": "MissingParameter.CommandId", /* 错误码 */
    "Message": "The input parameter “CommandId” that is mandatory for processing this request is not supplied." /* 错误信息 */
}