CreateConsumerGroup - - Centre de documentation Alibaba Cloud

Crée un groupe de consommateurs pour ApsaraMQ for RocketMQ. Un groupe de consommateurs est un groupe d'équilibrage de charge qui contient plusieurs consommateurs ayant le même comportement de consommation. Les consommateurs doivent spécifier un groupe de consommateurs et les sujets pertinents pour s'abonner aux messages.

Description de l'opération

Important

L'OpenAPI d'Alibaba Cloud est une API de gestion utilisée pour gérer et interroger les ressources des services Alibaba Cloud. Intégrez cette API uniquement à des fins de gestion. N'utilisez pas cette API pour les liaisons de données principales qui envoient et reçoivent des messages. Cela peut introduire des risques pour vos liaisons de données.

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 le groupe de consommateurs appartient.	rmq-cn-7e22ody****
consumerGroupId	string	Oui	L'identifiant du groupe de consommateurs que vous souhaitez créer. Cet identifiant est utilisé pour identifier le groupe de consommateurs et doit être globalement unique. La valeur doit respecter les exigences suivantes : L'identifiant peut contenir des lettres, des chiffres, des traits de soulignement (_) et des traits d'union (-). L'identifiant doit comporter entre 1 et 60 caractères. Pour plus d'informations sur les caractères 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	Le corps de la requête.
remark	string	Non	Les remarques sur le groupe de consommateurs.	Ceci est la remarque de test
deliveryOrderType	string	Oui	L'ordre de distribution du groupe de consommateurs. Valeurs valides : Concurrently : les messages sont distribués de manière simultanée. Orderly : les messages sont distribués dans l'ordre. Valeurs valides : Concurrently : Distribution simultanée. Orderly : Distribution ordonnée.	Concurrently
consumeRetryPolicy	object	Oui	La stratégie de nouvelle tentative pour le groupe de consommateurs. Pour plus d'informations, consultez Nouvelle tentative de message.
maxRetryTimes	integer	Non	Le nombre maximal de nouvelles tentatives.	16
retryPolicy	string	Oui	Le type de stratégie de nouvelle tentative. Pour plus d'informations, consultez Nouvelle tentative de message. Valeurs valides : FixedRetryPolicy : effectue de nouvelles tentatives à intervalle fixe. Cette stratégie n'est disponible que pour la distribution ordonnée des messages. DefaultRetryPolicy : effectue de nouvelles tentatives avec temporisation. Cette stratégie n'est disponible que pour la distribution simultanée des messages. Valeurs valides : FixedRetryPolicy : Nouvelle tentative à intervalle fixe. DefaultRetryPolicy : Nouvelle tentative avec temporisation.	DefaultRetryPolicy
deadLetterTargetTopic	string	Non	Le sujet de lettres mortes. Si un consommateur ne parvient pas à consommer un message après le nombre maximal de nouvelles tentatives, le message est distribué à un sujet de lettres mortes. Vous pouvez ensuite effectuer une reprise d'activité ou retracer le message. Pour plus d'informations, consultez Nouvelle tentative de message et lettres mortes.	DLQ_mqtest
fixedIntervalRetryTime	integer	Non	L'intervalle fixe de nouvelle tentative. Unité : secondes. Ce paramètre n'est valide que si vous définissez la stratégie de nouvelle tentative sur FixedRetryPolicy. Valeurs valides : Distribution simultanée : 10 à 1800 Distribution ordonnée : 1 à 600	10
maxReceiveTps	integer	Non	Le nombre maximal de TPS pour la consommation de messages.	1000
messageModel	string	Non	Le mode de consommation. Valeurs valides : CLUSTERING LITE_SELECTIVE	LITE_SELECTIVE
topicName	string	Non	Le nom du sujet lite auquel le groupe de consommateurs s'abonne. Ce paramètre est requis si vous définissez messageModel sur LITE_SELECTIVE.	liteTopicTest
exclusive	boolean	Non

Éléments de réponse

Élément	Type	Description	Exemple
	object	Result<boolean>
requestId	string	L'identifiant de la requête. Chaque requête possède un identifiant unique. Vous pouvez utiliser cet identifiant pour dépanner et localiser les problèmes.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indique si l'appel a réussi.	true
data	boolean	Les données renvoyées.	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": "Parameter consumerGroupId is invalid.",
  "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.