All Products
Search
Document Center

:ResetConsumeOffset

最終更新日:Sep 09, 2024

Resets the consumer offset of a consumer group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rocketmq:ResetConsumeOffsetupdate
  • ConsumerGroup
    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}
    none
none

Request syntax

PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName}

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

rmq-cn-tl32ue44x0g
consumerGroupIdstringYes

The consumer group ID.

dolphin_status
topicNamestringYes

The topic name.

AMZN_REPORT_TOPIC
bodyobjectNo

The request body.

resetTypestringNo

The method that is used to reset the consumer offset. Valid values: LATEST_OFFSET and SPECIFIED_TIME.

LATEST_OFFSET
resetTimestringNo

The time when the consumer offset is reset.

2023-03-22 12:17:08

Response parameters

ParameterTypeDescriptionExample
object

Result

requestIdstring

The request ID.

F9A95891-EAD4-5A2B-8A30-676CD18921AF
successboolean

Indicates whether the request is successful.

true
codestring

The returned error code.

MissingInstanceId
messagestring

The returned error message.

The instance cannot be found.
httpStatusCodeinteger

The returned HTTP status code.

200
dynamicCodestring

The returned dynamic error code.

InstanceId
dynamicMessagestring

The returned dynamic error message.

instanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "F9A95891-EAD4-5A2B-8A30-676CD18921AF",
  "success": true,
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history