All Products
Search
Document Center

OnsConsumerTimeSpan

Last Updated: Sep 13, 2019

OnsConsumerTimeSpan

You can call this operation to query the timestamps of the latest messages and the latest time of consumption corresponding to the topics subscribed to under the group ID.

Description

You can call this operation to query the latest time and earliest time of messages corresponding to a topic on the MQ broker, as well as the last consumption time on the consumer. The operation is used to display the consumption progress, and is used with OnsConsumerAccumulate. For more information about OnsConsumerAccumulate, see OnsConsumerAccumulate.

Request parameters

Name Type Required Description
InstanceId String No The ID of the instance.
PreventCache Long Yes The parameter used for CSRF verification, which can be set to the current system time. Unit: ms
GroupId String Yes The group ID of the consumer you want to query.
Topic String Yes The topic the target group ID subscribed to.

Response parameters

Name Type Description
RequestId String A common parameter. Each request has a unique ID.
HelpUrl String A help link.
Data Data The query results.

Fields in Data

Name Type Description
Topic String The name of the topic you want to query.
MinTimeStamp Long The time when the latest message is stored under the entire topic.
MaxTimeStamp Long The time when the earliest message is stored under the entire topic.
ConsumeTimeStamp Long The latest time when the current group consumes the topic.

Examples

For more information about sample codes, see API sample code and endpoints.