GetConsumerGroup - - Centre de documentation Alibaba Cloud

Obtient les détails d'un groupe de consommateurs spécifié.

Description de l'opération

Important L'OpenAPI fournie par Alibaba Cloud est une API de gestion et de contrôle utilisée pour gérer et interroger les ressources associées aux services Alibaba Cloud. Elle est recommandée uniquement pour l'intégration dans les liaisons de données de gestion et de contrôle. L'utilisation de l'OpenAPI dans la liaison de données principale pour l'envoi et la réception de messages est strictement interdite. Dans le cas contraire, des risques peuvent survenir dans la liaison 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:GetConsumerGroup

get

*ConsumerGroup.

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

Aucune

Syntaxe de la requête

GET /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 à interroger.	rmq-cn-7e22ody****
consumerGroupId	string	Oui	L'identifiant du groupe de consommateurs à interroger.	CID-TEST

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

É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 peut être utilisé pour dépanner et localiser les défaillances.	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	Indique si l'opération d'exécution a réussi.	true
data	object	Le résultat renvoyé.
regionId	string	L'identifiant de la région de l'instance.	cn-hangzhou
instanceId	string	L'identifiant de l'instance à laquelle appartient le groupe de consommateurs.	rmq-cn-7e22ody****
consumerGroupId	string	L'identifiant du groupe de consommateurs.	CID-TEST
status	string	L'état du groupe de consommateurs. Valeurs valides : RUNNING : En cours d'exécution. CREATING : En cours de création.	RUNNING
remark	string	Les remarques du groupe de consommateurs.	Ceci est la remarque de test
createTime	string	L'heure à laquelle le groupe de consommateurs a été créé, au format AAAA-MM-JJ HH:mm:ss.	2022-08-01 20:05:50
updateTime	string	L'heure de la dernière mise à jour du groupe de consommateurs, au format AAAA-MM-JJ HH:mm:ss.	2022-08-01 20:05:50
deliveryOrderType	string	L'ordre de distribution du groupe de consommateurs. Valeurs valides : Concurrently : Distribution simultanée. Orderly : Distribution ordonnée.	Concurrently
consumeRetryPolicy	object	La stratégie de nouvelle tentative de consommation du groupe de consommateurs. Pour plus d'informations, consultez Nouvelle tentative de consommation.
retryPolicy	string	Le type de stratégie de nouvelle tentative. Valeurs valides : FixedRetryPolicy : Nouvelle tentative à intervalle fixe. DefaultRetryPolicy : Nouvelle tentative avec temporisation exponentielle.	DefaultRetryPolicy
maxRetryTimes	integer	Le nombre maximal de nouvelles tentatives.	16
deadLetterTargetTopic	string	Le sujet de lettres mortes. Si un consommateur ne parvient pas à consommer un message en raison d'une exception et que le message ne peut toujours pas être consommé après les nouvelles tentatives, le message est distribué au sujet de lettres mortes pour une reprise ou une vérification ultérieure de l'activité. Pour plus d'informations, consultez Nouvelles tentatives de consommation et messages de lettres mortes.	DLQ_mqtest
fixedIntervalRetryTime	integer	L'intervalle fixe de nouvelle tentative. Unité : secondes. Concurrently (distribution simultanée) : 10-1800 Orderly (distribution ordonnée) : 1-600	20
maxReceiveTps	integer	Le nombre maximal de TPS pour la consommation de messages.	2000
messageModel	string	Le mode de consommation. Valeurs valides : CLUSTERING : consommation en cluster. LITE_SELECTIVE : LITE_SELECTIVE.	LITE_SELECTIVE
topicName	string	Le nom du sujet pour le type lite.	test1
exclusive	boolean	Indique si la consommation exclusive est activée.	false
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": "C7F94090-3358-506A-97DC-34BC803C****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "status": "RUNNING",
    "remark": "Ceci est la remarque pour le test",
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "deliveryOrderType": "Concurrently",
    "consumeRetryPolicy": {
      "retryPolicy": "DefaultRetryPolicy",
      "maxRetryTimes": 16,
      "deadLetterTargetTopic": "DLQ_mqtest",
      "fixedIntervalRetryTime": 20
    },
    "maxReceiveTps": 2000,
    "messageModel": "LITE_SELECTIVE",
    "topicName": "test1",
    "exclusive": false
  },
  "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.