重发消息 - ResetMessages
功能介绍
重发消息。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/mqs/instances/{instance_id}/messages/action
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
|
instance_id |
是 |
String |
实例ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
action_id |
是 |
String |
重发类型。当前只支持“resend”。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
topic |
是 |
String |
Topic名称。 |
|
partition |
是 |
Integer |
分区。 |
|
message_offset |
是 |
Number |
消息偏移量。 |
|
consumer_key |
否 |
String |
应用Key。在该消息头中添加一个consumer_key的消息头。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
topic |
String |
Topic名称。 |
|
partition |
Integer |
分区。 |
|
message_offset |
Integer |
消息偏移量。 |
|
consumer_key |
String |
应用Key。在该消息头中添加一个consumer_key的消息头。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
请求示例
重发偏移量为4的消息,并为该消息添加指定消息头
POST https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/messages/action?action_id=resend
{
"topic" : "topic-test",
"partition" : 0,
"message_offset" : 4,
"consumer_key" : "keyA"
}
响应示例
状态码:200
OK
{
"topic" : "topic-test",
"partition" : 0,
"message_offset" : 4,
"consumer_key" : "keyA"
}
状态码:400
Bad Request
{
"error_code" : 400,
"error_msg" : "Bad Request"
}
状态码:403
Forbidden
{
"error_code" : 403,
"error_msg" : "Forbidden"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
403 |
Forbidden |
错误码
请参见错误码。