UpdateConsumerGroup - - Centre de documentation Alibaba Cloud

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 des services Alibaba Cloud. Il est recommandé de l'utiliser uniquement pour l'intégration dans les liens de gestion et de contrôle. N'utilisez pas l'OpenAPI dans le lien de données principal pour l'envoi et la réception de messages. Sinon, des risques peuvent survenir sur le lien 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 appartient le groupe de consommateurs à mettre à jour.	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	Les remarques mises à jour du groupe de consommateurs.	Ceci est la remarque pour le test
deliveryOrderType `deprecated`	string	Non	La modification n'est pas prise en charge. Valeurs valides : Concurrently : Distribution simultanée. Orderly : Distribution ordonnée.	Concurrently
consumeRetryPolicy	object	Oui	La stratégie de nouvelle tentative de consommation mise à jour du groupe de consommateurs. Pour plus d'informations, consultez Nouvelle tentative de consommation.
retryPolicy	string	Oui	Le type de stratégie de nouvelle tentative. Pour plus d'informations, consultez Nouvelle tentative de message. Valeurs valides : FixedRetryPolicy : nouvelle tentative à intervalle fixe. Seule la distribution ordonnée est prise en charge. DefaultRetryPolicy : nouvelle tentative avec backoff incrémentiel. Seule la distribution simultanée est prise en charge. Valeurs valides : FixedRetryPolicy : Nouvelle tentative à intervalle fixe. DefaultRetryPolicy : Nouvelle tentative avec backoff incrémentiel.	DefaultRetryPolicy
maxRetryTimes	integer	Non	Le nombre maximal de nouvelles tentatives.	16
deadLetterTargetTopic	string	Non	Le sujet des 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 distribué au sujet des lettres mortes pour une récupération ou une révision ultérieure de l'activité. Pour plus d'informations, consultez Nouvelles tentatives de consommation et messages de lettre morte.	DLQ_mqtest
fixedIntervalRetryTime	integer	Non	L'intervalle de nouvelle tentative fixe. Unité : secondes. Ce paramètre ne prend effet que lorsque la stratégie de nouvelle tentative est définie sur FixedRetryPolicy (nouvelle tentative à intervalle fixe). Valeurs valides : Distribution simultanée : 10-1800 Distribution ordonnée : 1-600	10
maxReceiveTps	integer	Non	La limite supérieure de TPS pour la consommation de messages.	1000

É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 que vous pouvez utiliser pour dépanner et localiser les problèmes.	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	Indique si l'exécution 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": "Le paramètre deliveryOrderType n'est pas valide",
  "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.