接口介绍
重置消息服务订阅组消费进度到指定时间戳。
接口约束
无。
URl
POST https://[endpoint].ctapi.ctyun.cn/v2/consumer/resetOffset
请求参数
请求参数 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
prodInstId | 是 | url | String | 实例ID |
groupName | 是 | url | String | 订阅组名字 |
topicName | 是 | url | String | Topic名字 |
resetTime | 是 | url | long | 要重置的毫秒时间戳 |
响应参数
响应参数 | 参数类型 | 描述 |
---|---|---|
statusCode | String | 接口系统层面状态码。成功:800,失败:900 |
message | String | 描述状态 |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 |
返回值returnObj参数说明
响应参数 | 参数类型 | 描述 |
---|---|---|
total | Integer | 重置消息总数 |
diffOffset | Integer | 偏移量差值 |
rows | List | 队列重置列表 |
返回值rows参数说明
响应参数 | 参数类型 | 描述 |
---|---|---|
brokerName | Integer | 重置消息总数 |
queueId | Integer | 偏移量差值 |
brokerOffset | List | 队列重置列表 |
consumerOffset | Integer | 消费进度 |
timestampOffset | Integer | 重置时间偏移量 |
rollbackOffset | Integer | 回滚偏移量 |
请求示例
POST https://[endpoint].ctapi.ctyun.cn/v2/consumer/resetOffset
{
"prodInstId":"mq_test",
"groupName":"group",
"topicName":"test",
"resetTime":1661843664000
}
响应成功示例
{
"returnObj":{
"total":4,
"diffOffset":5,
"rows":[
{
"brokerName":"mq_test_broker_1",
"queueId":0,
"brokerOffset":6,
"consumerOffset":6,
"timestampOffset":5,
"rollbackOffset":5
},
{
"brokerName":"mq_test_broker_1",
"queueId":1,
"brokerOffset":6,
"consumerOffset":6,
"timestampOffset":5,
"rollbackOffset":5
},
{
"brokerName":"mq_test_broker_1",
"queueId":2,
"brokerOffset":7,
"consumerOffset":7,
"timestampOffset":6,
"rollbackOffset":6
},
{
"brokerName":"mq_test_broker_1",
"queueId":3,
"brokerOffset":8,
"consumerOffset":8,
"timestampOffset":6,
"rollbackOffset":6
}
]
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}