接口描述
本接口 (RewindQueue)用于消息回溯功能,具体功能参见 消息回溯功能。
- 外网接口请求域名:
https://cmq-queue-{$region}.api.qcloud.com
- 内网接口请求域名:
http://cmq-queue-{$region}.api.tencentyun.com
上述域名中的{$region}需用具体地域替换:gz(广州)、sh(上海)、bj(北京)、shjr(上海金融)、szjr(深圳金融)、hk(中国香港)、cd(成都)、ca(北美)、usw(美西)、sg(新加坡)。公共参数中的 region 值要与域名的 region 值保持一致,如果出现不一致的情况,以域名的 region 值为准,将请求发往域名 region 所指定的地域。
注意:任何时候(包括内测期间),如果使用外网域名产生公网下行流量,都会收取流量费用。 所以强烈建议服务在腾讯云上的用户使用内网域名,内网不会产生流量费用。
输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
queueName | 是 | String | 队列名字,在单个地域同一账号下唯一。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。 |
startConsumeTime | 是 | Unix 时间戳 | 设定该时间,则(Batch)receiveMessage 接口,会按照生产消息的先后顺序消费该时间戳以后的消息。 |
输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 0:表示成功,others:错误,详细错误见下表。 |
message | String | 错误提示信息。 |
requestId | String | 服务器生成的请求 ID。出现服务器内部错误时,用户可提交此 ID 给后台定位问题。 |
错误码
以下是接口特有错误码,如果您要查找的错误码不在其中,可能在 公共错误码中。
错误代码 | 模块错误代码 | 英文提示 | 描述 |
---|---|---|---|
6050 | 10670 | your queue cannot be rewinded | 队列无法回溯。 |
4000 | 10680 | invalid rewind time, you can get the vaild range of that via GetQueueAttributes | 回溯时间错误,可以查看队列属性,获取正确的回溯时间。 |
4000 | 10700 | rewindSeconds cannot be greater than msgRetentionSeconds | 回溯时间不能大于消息保留时间。 |
示例
输入:
https://domain/v2/index.php?Action=RewindQueue &queueName=test-queue-123&startConsumeTime=unix时间戳 &<公共请求参数>
输出:
{
"code" : 0,
"message" : "",
"requestId":"14534664555"
}