GetConsumeTimespan - - Centre de documentation Alibaba Cloud

Consulte la plage de temps pendant laquelle l'offset d'un consommateur peut être réinitialisé pour un topic.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

rocketmq:GetConsumeTimespan

get

*ConsumerGroup

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

Aucune

Syntaxe de la requête

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

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance.	rmq-cn-7e22ody****
consumerGroupId	string	Oui	L'identifiant du groupe de consommateurs.	CID-TEST
topicName	string	Oui	Le nom du topic auquel le groupe de consommateurs est abonné.	topicxxx

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object	Résultat.
requestId	string	L'identifiant unique de la requête. Utilisez cet identifiant pour résoudre les problèmes.	C115601B-8736-5BBF-AC99-7FEAE1245A80
success	boolean	Indique si la requête a réussi.	true
data	object	Les données renvoyées.
instanceId	string	L'identifiant de l'instance.	rmq-cn-7e22ody****
topicName	string	Le topic auquel le groupe de consommateurs est abonné.	topic_test
consumerGroupId	string	L'identifiant du groupe de consommateurs.	CID-TEST
minTimestamp	integer	L'heure de production du message le plus ancien dans le topic.	1570761026222
maxTimestamp	integer	L'heure de production du message le plus récent dans le topic.	1570761026833
consumeTimestamp	integer	La dernière fois que le groupe de consommateurs a consommé un message de ce topic.	1570761026400
code	string	Le code d'erreur.	MissingInstanceId
message	string	Le message d'erreur.	Le paramètre instanceId est obligatoire pour cette action
httpStatusCode	integer	Le code d'état HTTP.	200
dynamicCode	string	Le code d'erreur dynamique.	xxx
dynamicMessage	string	Le message d'erreur dynamique.	xxx

Exemples

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"
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.