OnsGroupList - - Centre de documentation Alibaba Cloud

Remarque

Cette opération renvoie la liste des groupes de consommateurs, sans en retourner les détails.

Limite QPS

Chaque compte Alibaba Cloud peut appeler cette opération jusqu'à 10 fois par seconde. Si le nombre de requêtes envoyées en une seconde dépasse la limite de requêtes par seconde (QPS), un mécanisme de limitation se déclenche et peut interrompre votre activité. Pour connaître la limite QPS de chaque opération, consultez la page Limites de débit des API.

Autorisation

Par défaut, les comptes Alibaba Cloud peuvent appeler cette opération. Un utilisateur RAM (Resource Access Management) ne peut l'appeler qu'après avoir reçu les autorisations requises. Le tableau suivant décrit les autorisations à accorder à un utilisateur RAM pour appeler cette opération.

API	Action	Resource
OnsGroupList	mq:QueryInstanceBaseInfo	acs:mq:::{instanceId}

Remarque

Lorsque vous utilisez les identifiants d'un utilisateur RAM pour appeler cette opération, celle-ci renvoie uniquement les informations sur les groupes de consommateurs pour lesquels l'utilisateur dispose des autorisations requises. Connectez-vous à la console RAM avec votre compte Alibaba Cloud pour accorder à l'utilisateur RAM les autorisations nécessaires sur les groupes de consommateurs auxquels vous souhaitez accéder. Pour plus d'informations sur l'octroi des autorisations, consultez la page

Politiques

.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	OnsGroupList	Opération à effectuer. Définissez la valeur sur OnsGroupList.
InstanceId	String	Yes	MQ_INST_111111111111_DOxxxxxx	ID de l'instance Message Queue for Apache RocketMQ à laquelle appartiennent les groupes de consommateurs à interroger.
GroupId	String	No	GID_test_group_id	Ce paramètre est requis uniquement pour interroger des groupes de consommateurs spécifiques via une recherche floue. S'il n'est pas configuré, le système interroge tous les groupes de consommateurs accessibles par le compte actuel. Si vous définissez ce paramètre sur GID_ABC, les informations relatives aux groupes de consommateurs dont les ID contiennent GID_ABC sont renvoyées. Par exemple, les informations sur les groupes GID_test_GID_ABC_123 et GID_ABC_356 sont renvoyées.
GroupType	String	No	tcp	Protocole utilisé par les groupes de consommateurs interrogés pour consommer les messages. Tous les clients d'un groupe de consommateurs communiquent avec le broker Message Queue for Apache RocketMQ via le même protocole. Un groupe de consommateurs ne peut pas contenir simultanément des clients TCP et HTTP. Vous devez créer des groupes distincts pour les clients TCP et HTTP. Valeurs valides : tcp : spécifie les groupes de consommateurs qui consomment des messages via TCP. Il s'agit de la valeur par défaut. http : spécifie les groupes de consommateurs qui consomment des messages via HTTP.
Tag.N.Key	String	Yes	CartService	Clé d'un tag associé au groupe de consommateurs. Ce paramètre est facultatif. Si vous le configurez, vous devez également configurer le paramètre Tag.N.Value. Si vous spécifiez des tags, le système filtre les groupes de consommateurs en fonction des tags indiqués. Sinon, il interroge tous les groupes de consommateurs accessibles par le compte actuel. Valeurs valides pour N : 1 à 20. La valeur du paramètre ne peut pas être une chaîne vide. La valeur peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par acs: ou aliyun, ni contenir http:// ou https://.
Tag.N.Value	String	Yes	ServiceA	Valeur du tag spécifié par le paramètre Tag.N.Key. Ce paramètre est facultatif. Si vous le configurez, vous devez également configurer le paramètre Tag.N.Value. Si vous spécifiez des tags, le système filtre les groupes de consommateurs en fonction des tags indiqués. Sinon, il interroge tous les groupes de consommateurs accessibles par le compte actuel. Valeurs valides pour N : 1 à 20. La valeur du paramètre peut être une chaîne vide. La valeur peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par acs: ou aliyun, ni contenir http:// ou https://.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	16996623-AC4A-43AF-9248-FD9D2D75****	ID de la requête. Le système génère un ID unique pour chaque requête. Vous pouvez résoudre les problèmes en vous basant sur cet ID.
Data	Array of SubscribeInfoDo		Données renvoyées.
SubscribeInfoDo
Owner	String	138015630679****	ID de l'utilisateur ayant créé le groupe de consommateurs.
UpdateTime	Long	1570700979000	Dernière mise à jour du groupe de consommateurs.
IndependentNaming	Boolean	true	Indique si un namespace est configuré pour l'instance Message Queue for Apache RocketMQ à laquelle appartient le groupe de consommateurs. Valeurs valides : true : Un namespace séparé est configuré pour l'instance. Le nom de chaque ressource doit être unique au sein de l'instance. Les ressources de différentes instances peuvent utiliser le même nom. false : Aucun namespace séparé n'est configuré pour l'instance. Le nom de chaque ressource doit être unique parmi toutes les instances.
GroupId	String	GID_test_group_id	ID du groupe de consommateurs.
Remark	String	test	Description du groupe de consommateurs.
CreateTime	Long	1568896605000	Date de création du groupe de consommateurs.
Tags	Array of Tag		Tags associés au groupe de consommateurs.
Tag
Key	String	CartService	Clé du tag.
Value	String	ServiceA	Valeur du tag.
InstanceId	String	MQ_INST_111111111111_DOxxxxxx	ID de l'instance.
GroupType	String	tcp	Protocole utilisé par les groupes de consommateurs interrogés pour consommer les messages. Tous les clients d'un groupe de consommateurs communiquent avec le broker Message Queue for Apache RocketMQ via le même protocole. Un groupe de consommateurs ne peut pas contenir simultanément des clients TCP et HTTP. Vous devez créer des groupes distincts pour les clients TCP et HTTP. Valeurs valides : tcp : indique que le groupe de consommateurs consomme des messages via TCP. http : indique que le groupe de consommateurs consomme des messages via HTTP.

Exemples

Exemples de requêtes

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsGroupList
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Tag.1.Key=CartService
&Tag.1.Value=ServiceA
&<Common request parameters>

Exemples de réponses réussies

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsGroupListResponse>
<RequestId>16996623-AC4A-43AF-9248-FD9D2D75****</RequestId>
<Data>
    <SubscribeInfoDo>
        <Owner>138015630679****</Owner>
        <GroupType>tcp</GroupType>
        <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
        <CreateTime>1568896605000</CreateTime>
        <UpdateTime>1570700979000</UpdateTime>
        <IndependentNaming>true</IndependentNaming>
        <GroupId>GID_test_group_id</GroupId>
        <Remark>test</Remark>
        <Tags>
            <Tag>
                <Value>ServiceA</Value>
                <Key>CartService</Key>
            </Tag>
        </Tags>
    </SubscribeInfoDo>
</Data>
</OnsGroupListResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "16996623-AC4A-43AF-9248-FD9D2D75****",
  "Data" : {
    "SubscribeInfoDo" : [ {
      "Owner" : "138015630679****",
      "GroupType" : "tcp",
      "InstanceId" : "MQ_INST_111111111111_DOxxxxxx",
      "CreateTime" : 1568896605000,
      "UpdateTime" : 1570700979000,
      "IndependentNaming" : true,
      "GroupId" : "GID_test_group_id",
      "Remark" : "test",
      "Tags" : {
        "Tag" : [ {
          "Value" : "ServiceA",
          "Key" : "CartService"
        } ]
      }
    } ]
  }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.