ConsumerGroupHeartBeat - - Centre de documentation Alibaba Cloud

Description de l'opération

Description de l'API

Le Host se compose d'un nom de projet et d'un point de terminaison Simple Log Service. Vous devez spécifier le projet dans le Host.
Un consommateur envoie des signaux de présence au serveur à intervalles fixes pour maintenir sa connexion. Si le serveur ne reçoit pas de signal de présence de la part du consommateur dans un délai spécifié, le consommateur est supprimé.
Obtenez une paire de clés AccessKey. Pour plus d'informations, consultez Paire de clés AccessKey.

Une paire de clés AccessKey d'un compte Alibaba Cloud dispose des autorisations pour toutes les opérations d'API. Cela représente une menace élevée pour la sécurité. Nous vous recommandons de créer et d'utiliser un utilisateur RAM pour appeler les opérations d'API ou effectuer des opérations courantes d'exploitation et de maintenance. L'utilisateur RAM doit disposer des autorisations pour gérer les ressources Simple Log Service. Pour plus d'informations, consultez Créer et autoriser un utilisateur RAM.

Obtenez le nom du projet, la région et le nom du Logstore. Pour plus d'informations, consultez Gérer un projet et Gérer un Logstore.
Obtenez le nom du groupe de consommateurs. Pour plus d'informations, consultez ListConsumerGroup.

Informations d'autorisation

Le tableau suivant décrit les informations d'autorisation pour cette opération. Ajoutez ces informations à l'élément Action d'une stratégie RAM pour accorder à un utilisateur RAM ou à un rôle RAM les autorisations nécessaires pour appeler cette opération d'API.

Action	Ressource dans une stratégie d'autorisation
`log:ConsumerGroupHeartBeat`	`acs:log:${regionId}:${accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/{#ConsumerGroupName}`

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.

log:ConsumerGroupHeartBeat

none

*All Resource

*

log:TLSVersion

Aucune

Syntaxe de la requête

POST /logstores/{logstore}/consumergroups/{consumerGroup}?type=heartbeat HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
logstore	string	Oui	Le nom du Logstore.	ali-test-logstore
consumerGroup	string	Oui	Le nom du groupe de consommateurs. Le nom doit être unique au sein d'un projet.	consumer_group_test

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
project	string	Oui	Le nom du projet.	ali-test-project
consumer	string	Oui	Le consommateur.	consumer_1
body	array	Oui	La liste des identifiants de fragment en cours de consommation.
	integer	Non	La liste des identifiants de fragment en cours de consommation.	[0]

Éléments de réponse

Élément	Type	Description	Exemple
	array	La liste de tous les identifiants de fragment consommés par le consommateur.
	integer	La liste de tous les identifiants de fragment consommés par le consommateur.	[0]

Exemples

JSON format

[
  0
]

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.