本文列举了消息队列RocketMQ版的API的公共请求参数和公共返回参数。

公共请求参数

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

名称 类型 是否必需 描述
Format String 否 返回消息的格式。取值：JSON | XML（默认值）
productName String 是 API的产品名称，直接填写Ons即可。
domain String 是 API的接入点domain，规则是ons.${RegionId}.aliyuncs.com，该domain对应的地域必须和regionId对应的地域一致。
Version String 是 API版本号，使用YYYY-MM-DD日期格式。取值：2019-02-14
AccessKeyId String 是 访问服务使用的密钥对。
  • 如果您以阿里云账号（主账号）或RAM用户（子账号）调用API，则此参数为阿里云账号或RAM用户的accessKeyId/accessKeySecret。
  • 如果您以RAM角色调用API，则此参数为您获取的STS安全令牌中的AccessKey ID或AccessKey Secret。更多信息，请参见RAM主子账号授权。
AccessKeySecret String 是
Signature String 是 签名结果串。
SignatureMethod String 是 签名方式。取值：HMAC-SHA1
Timestamp String 是 请求的时间戳，为日期格式。使用UTC时间按照ISO 8601标准，格式为YYYY-MM-DDThh:mm:ssZ。例如，北京时间2013年01月10日20点0分0秒，表示为2013-01-10T12:00:00Z。
SignatureVersion String 是 签名算法版本。取值：1.0
SignatureNonce String 是 唯一随机数，用于防止网络重放攻击。在不同请求间要使用不同的随机数值。

请求示例

https://ons.cn-hangzhou.aliyuncs.com/?Action=OnsRegionList
&Format=JSON
&Version=2019-02-14
&AccessKeyId=key-test
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&Timestamp=2020-01-01T12:00:00Z
&SignatureNonce=1521552885****
&SignatureVersion=1.0
…

公共返回参数

每次接口调用请求，无论成功与否，系统都会返回一个唯一识别码RequestId。调用API服务后返回数据采用统一格式。返回的HTTP状态码为2xx，代表调用成功；返回的HTTP状态码为4xx或5xx，代表调用失败。

XML示例

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

JSON示例

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