CreateConsumerGroup - - Centre de documentation Alibaba Cloud

Crée un groupe de consommateurs (ConsumerGroup) pour ApsaraMQ for RocketMQ. Un groupe de consommateurs est un groupe d'équilibrage de charge dans ApsaraMQ for RocketMQ qui contient plusieurs consommateurs ayant un comportement de consommation cohérent. Les consommateurs doivent s'abonner aux sujets associés en spécifiant un groupe de consommateurs pour implémenter l'abonnement aux messages.

Description de l'opération

Important Les opérations OpenAPI fournies par Alibaba Cloud sont des API de gestion utilisées pour gérer et interroger les ressources des services Alibaba Cloud. Utilisez ces opérations uniquement dans la chaîne de gestion. Ne les utilisez pas dans la chaîne de données principale pour l'envoi et la réception de messages, car cela pourrait introduire des risques pour la chaîne.

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:CreateConsumerGroup

create

*ConsumerGroup.

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

Aucune

Syntaxe de la requête

POST /instances/{instanceId}/consumerGroups/{consumerGroupId} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance à laquelle appartient le groupe de consommateurs à créer.	rmq-cn-7e22ody****
consumerGroupId	string	Oui	L'identifiant du groupe de consommateurs à créer. Utilisé comme identité du groupe de consommateurs, qui est globalement unique. Valeurs valides : Restrictions de caractères : lettres de a à z ou de A à Z, chiffres de 0 à 9, traits de soulignement (_) et traits d'union (-). Restrictions de longueur : de 1 à 60 caractères. Pour les restrictions relatives aux mots réservés, consultez Limites des paramètres.	GID_test_groupId

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
body	object	Non	L'objet du corps de la requête.
remark	string	Non	Les remarques pour le groupe de consommateurs à créer.	Ceci est la remarque pour le test
deliveryOrderType	string	Oui	Le type d'ordre de livraison du groupe de consommateurs à créer. Valeurs valides du paramètre : Concurrently : livraison simultanée Orderly : livraison ordonnée Valeurs valides : Concurrently : Livraison simultanée. Orderly : Livraison ordonnée.	Concurrently
consumeRetryPolicy	object	Oui	La stratégie de nouvelle tentative de consommation du groupe de consommateurs à créer. Pour plus d'informations, consultez Nouvelle tentative de consommation.
maxRetryTimes	integer	Non	Le nombre maximal de tentatives.	16
retryPolicy	string	Oui	Le type de stratégie de nouvelle tentative. Pour plus d'informations, consultez Nouvelle tentative de message. Valeurs valides du paramètre : FixedRetryPolicy : nouvelle tentative à intervalle fixe, prise en charge uniquement pour la livraison ordonnée DefaultRetryPolicy : nouvelle tentative avec temporisation progressive, prise en charge uniquement pour la livraison simultanée Valeurs valides : FixedRetryPolicy : Nouvelle tentative à intervalle fixe. DefaultRetryPolicy : Nouvelle tentative avec temporisation progressive.	DefaultRetryPolicy
deadLetterTargetTopic	string	Non	Le sujet de lettres mortes. Si un consommateur ne parvient pas à consommer un message et que le message échoue toujours après les nouvelles tentatives, le message est livré au sujet de lettres mortes pour une récupération ou un retour en arrière ultérieur de l'activité. Pour plus d'informations, consultez Nouvelles tentatives de consommation et messages de lettres mortes.	DLQ_mqtest
fixedIntervalRetryTime	integer	Non	L'intervalle de nouvelle tentative fixe, en secondes. Ce paramètre prend effet lorsque la stratégie de nouvelle tentative est définie sur FixedRetryPolicy. Valeurs valides : Livraison simultanée : de 10 à 1800 Livraison ordonnée : de 1 à 600	10
maxReceiveTps	integer	Non	Le nombre maximal de TPS pour la consommation de messages.	1000
messageModel	string	Non	Le mode d'abonnement pour les consommateurs : CLUSTERING : mode de consommation en cluster. Tous les consommateurs du ConsumerGroup partagent le même abonnement. LITE_SELECTIVE : mode de consommation allégé. Les consommateurs du ConsumerGroup peuvent avoir des abonnements différents. Valeurs valides : CLUSTERING : Mode de consommation en cluster. LITE_SELECTIVE : Mode de consommation allégé.	LITE_SELECTIVE
topicName	string	Non	Le nom du sujet de type allégé auquel s'abonner lors de l'utilisation du mode de consommation LITE_SELECTIVE.	liteTopicTest
exclusive	boolean	Non	Indique si l'abonnement exclusif doit être activé, ce qui signifie qu'un LiteTopic ne peut être abonné que par un seul consommateur. Définissez sur true pour activer ou sur false pour désactiver.

Éléments de réponse

Élément	Type	Description	Exemple
	object	Result
requestId	string	L'identifiant de la requête. Chaque requête possède un identifiant unique qui est actif et peut être utilisé pour dépanner et localiser les problèmes.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indique si l'opération d'exécution a réussi.	true
data	boolean	Le résultat renvoyé.	true
code	string	Le code d'erreur.	InvalidConsumerGroupId
message	string	Le message d'erreur.	Le paramètre consumerGroupId n'est pas valide
httpStatusCode	integer	Le code d'état HTTP.	400
dynamicCode	string	Le code d'erreur dynamique.	ConsumerGroupId
dynamicMessage	string	Le message d'erreur dynamique.	consumerGroupId

Exemples

JSON format

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": true,
  "code": "InvalidConsumerGroupId",
  "message": "Le paramètre consumerGroupId n'est pas valide",
  "httpStatusCode": 400,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.