UpdateConsumerGroup - - Centre de documentation Alibaba Cloud

Description de l'opération

Important

L'OpenAPI d'Alibaba Cloud est une API de gestion. Vous pouvez l'utiliser pour gérer et interroger les ressources des services Alibaba Cloud. Cette API est destinée uniquement à des fins de gestion. N'utilisez pas cette API pour les liaisons de données principales qui envoient et reçoivent des messages, car cela pourrait introduire des risques potentiels 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:UpdateConsumerGroup

update

*ConsumerGroup

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

Aucune

Syntaxe de la requête

PATCH /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-7e22on9****
consumerGroupId	string	Oui	L'identifiant du groupe de consommateurs à mettre à jour.	CID-TEST

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
body	object	Non	Le corps de la requête.
remark	string	Non	La remarque mise à jour pour le groupe de consommateurs.	Ceci est la remarque de test
deliveryOrderType `deprecated`	string	Non	Ce paramètre ne peut pas être modifié. Valeurs valides : Concurrently : Concurrent Orderly : Orderly	Concurrently
consumeRetryPolicy	object	Oui	La stratégie de nouvelle tentative de consommation mise à jour pour le groupe de consommateurs. Pour plus d'informations, consultez Nouvelle tentative de consommation.
retryPolicy	string	Oui	La stratégie de nouvelle tentative. Pour plus d'informations, consultez Nouvelle tentative de message. Valeurs valides : FixedRetryPolicy : nouvelle tentative à intervalle fixe. Cette stratégie s'applique uniquement aux messages séquentiels. DefaultRetryPolicy : nouvelle tentative avec temporisation. Cette stratégie s'applique uniquement aux messages concurrents. Valeurs valides : FixedRetryPolicy : Nouvelle tentative à intervalle fixe. DefaultRetryPolicy : Nouvelle tentative avec temporisation.	DefaultRetryPolicy
maxRetryTimes	integer	Non	Le nombre maximal de nouvelles tentatives.	16
deadLetterTargetTopic	string	Non	Le sujet de lettres mortes. Si un message ne peut pas être consommé après le nombre maximal de nouvelles tentatives, le message est envoyé à un sujet de lettres mortes. Vous pouvez ensuite effectuer une récupération métier ou tracer le message. Pour plus d'informations, consultez Nouvelle tentative de consommation et messages de lettre morte.	DLQ_mqtest
fixedIntervalRetryTime	integer	Non	L'intervalle de nouvelle tentative fixe. Unité : secondes. Ce paramètre n'est valide que si vous définissez le paramètre retryPolicy sur FixedRetryPolicy. Plage de valeurs : Distribution concurrente : 10 à 1800 Distribution séquentielle : 1 à 600	10
maxReceiveTps	integer	Non	Le nombre maximal de transactions par seconde (TPS) pour la consommation de messages.	1000

É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 le dépannage.	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	Indique si la requête a réussi.	true
data	boolean	Le résultat renvoyé.	true
code	string	Le code d'erreur.	InvalidDeliveryOrderType
message	string	Le message d'erreur.	Le paramètre deliveryOrderType n'est pas valide
httpStatusCode	integer	Le code d'état HTTP.	400
dynamicCode	string	Le code d'erreur dynamique.	DeliveryOrderType
dynamicMessage	string	Le message d'erreur dynamique.	deliveryOrderType

Exemples

JSON format

{
  "requestId": "C7F94090-3358-506A-97DC-34BC803C****",
  "success": true,
  "data": true,
  "code": "InvalidDeliveryOrderType",
  "message": "Parameter deliveryOrderType is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "DeliveryOrderType",
  "dynamicMessage": "deliveryOrderType"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.