本文列举了消息队列 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 安全令牌中的accessKeyId/accessKeySecret。详情参见RAM 主子账号授权
AccessKeySecret String
Signature String 签名结果串。
SignatureMethod String 签名方式。取值:HMAC-SHA1
Timestamp String 请求的时间戳,为日期格式。使用 UTC 时间按照 ISO 8601标准,格式为 YYYY-MM-DDThh:mm:ssZ。例如,北京时间 2013 年 1 月 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%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&Timestamp=2020-01-01T12:00:00Z
&SignatureNonce=15215528852396
&SignatureVersion=1.0
…            

公共返回参数

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

XML 示例

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

JSON 示例

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