OnsConsumerResetOffset - - Centre de documentation Alibaba Cloud

Description de l'opération

Remarque

Les opérations d'API fournies par Alibaba Cloud sont utilisées pour gérer et interroger les ressources des services Alibaba Cloud. Nous vous recommandons d'intégrer ces opérations d'API uniquement dans les systèmes de gestion. N'utilisez pas ces opérations d'API dans le système principal des services de messagerie. Sinon, des risques système peuvent survenir.

Vous pouvez appeler cette opération pour effacer les messages accumulés ou réinitialiser un offset de consommation à un horodatage spécifié. Vous pouvez utiliser l'une des méthodes suivantes pour effacer les messages accumulés :

Effacer tous les messages accumulés dans un topic spécifié.
Effacer les messages publiés dans le topic spécifié avant un instant donné.

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.

mq:ResetConsumerOffset

get

Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

Aucune

mq:OnsInstanceBaseInfo

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GroupId	string	Oui	L'identifiant du groupe de consommateurs pour lequel vous souhaitez interroger le message non distribuable.	GID_test_consumer_id
Topic	string	Oui	Le nom du topic pour lequel vous souhaitez réinitialiser l'offset de consommation.	test-mq-topic
Type	integer	Oui	La méthode que vous souhaitez utiliser pour effacer les messages accumulés. Valeurs valides : 0 : Tous les messages accumulés sont effacés. Les messages non consommés sont ignorés. Les consommateurs du groupe de consommateurs spécifié ne consomment que les messages publiés dans le topic après l'instant donné. Si « reconsumeLater » est renvoyé, les messages accumulés ne sont pas effacés car le système réessaie de renvoyer les messages aux consommateurs. 1 : Les messages publiés dans le topic avant l'instant donné sont effacés. Vous devez spécifier un instant donné. Les consommateurs du groupe de consommateurs spécifié ne consomment que les messages publiés dans le topic après l'instant donné. Vous pouvez spécifier un instant donné allant du premier instant de publication d'un message dans le topic au dernier instant de publication d'un message dans le topic. Les instants donnés qui ne se situent pas dans la plage de temps autorisée ne sont pas valides.	1
ResetTimestamp	integer	Non	L'horodatage auquel vous souhaitez réinitialiser l'offset de consommation. Ce paramètre prend effet uniquement lorsque le paramètre Type est défini sur 1. Unité : millisecondes.	1591153871000
InstanceId	string	Non	L'identifiant de l'instance à laquelle le groupe de consommateurs appartient.	MQ_INST_111111111111_DOxxxxxx

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête. Ce paramètre est un paramètre commun. Chaque requête possède un identifiant unique. Vous pouvez utiliser cet identifiant pour résoudre les problèmes.	D52C68F8-EC5D-4294-BFFF-1A6A25AF****

Exemples

JSON format

{
  "RequestId": "D52C68F8-EC5D-4294-BFFF-1A6A25AF****"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.