GetConsumeTimespan - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries the time range in which a consumer offset can be reset for a topic.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rocketmq:GetConsumeTimespan

get

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}/consumergroup/{#ConsumerGroupId}

None

Request syntax

GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeTimespan/{topicName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance.	rmq-cn-7e22ody****
consumerGroupId	string	Yes	The ID of the consumer group.	CID-TEST
topicName	string	Yes	The name of the topic to which the consumer group subscribes.	topicxxx

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Result
requestId	string	The unique ID of the request. Use this ID to troubleshoot issues.	C115601B-8736-5BBF-AC99-7FEAE1245A80
success	boolean	Indicates whether the request was successful.	true
data	object	The data returned.
instanceId	string	The ID of the instance.	rmq-cn-7e22ody****
topicName	string	The topic to which the consumer group subscribes.	topic_test
consumerGroupId	string	The ID of the consumer group.	CID-TEST
minTimestamp	integer	The production time of the earliest message in the topic.	1570761026222
maxTimestamp	integer	The production time of the latest message in the topic.	1570761026833
consumeTimestamp	integer	The last time the consumer group consumed a message from this topic.	1570761026400
code	string	The error code.	MissingInstanceId
message	string	The error message.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	xxx
dynamicMessage	string	The dynamic error message.	xxx

Examples

Success response

JSON format

{
  "requestId": "C115601B-8736-5BBF-AC99-7FEAE1245A80",
  "success": true,
  "data": {
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "consumerGroupId": "CID-TEST",
    "minTimestamp": 1570761026222,
    "maxTimestamp": 1570761026833,
    "consumeTimestamp": 1570761026400
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "xxx",
  "dynamicMessage": "xxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.