QueryConsumerGroupList - IoT Platform - Centre de documentation Alibaba Cloud

Répertorie tous les groupes de consommateurs associés à votre compte lorsque vous utilisez des abonnements côté serveur via AMQP. Vous pouvez également effectuer une recherche floue par nom de groupe de consommateurs.

Limites

Chaque compte Alibaba Cloud peut exécuter au maximum 5 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryConsumerGroupList	Opération à effectuer. Définissez la valeur sur QueryConsumerGroupList.
CurrentPage	Integer	Oui	1	Numéro de la page à renvoyer. La numérotation commence à 1.
PageSize	Integer	Non	2	Nombre d'entrées à renvoyer par page. Valeurs acceptées : 1 à 1000.
IotInstanceId	String	Non	iot-cn-0pp1n8t****	ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. À défaut, l'appel échoue. Si votre instance ne dispose pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez la rubrique Overview.
Fuzzy	Boolean	Non	false	Indique s'il faut effectuer une recherche floue. Valeurs acceptées : true : effectue une recherche floue. Vous devez spécifier le paramètre GroupName. false : interroge tous les groupes de consommateurs du compte actuel. Valeur par défaut : false.
GroupName	String	Non	Consumer groups of the A type	Nom du groupe de consommateurs à interroger. Ce paramètre est obligatoire si le paramètre Fuzzy est défini sur true.

Outre les paramètres de requête spécifiques à cette opération, vous devez spécifier les paramètres de requête communs lors de l'appel. Pour plus d'informations, consultez la rubrique Paramètres de requête communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
CurrentPage	Integer	1	Numéro de la page renvoyée.
Data	Array of ConsumerGroupDTO		Détails concernant le groupe de consommateurs. Ce paramètre est renvoyé si l'appel aboutit. Pour plus d'informations, consultez ConsumerGroupDTO.
ConsumerGroupDTO
CreateTime	String	2020-05-20T00:05:20.000Z	Date et heure de création du groupe de consommateurs. Le format suit la norme ISO 8601 (yyyy-MM-ddTHH:mm:ss.SSSZ). L'heure est affichée au format UTC avec une précision à la milliseconde.
GroupId	String	nJRaJPn5U1JITGf******	ID du groupe de consommateurs.
GroupName	String	Consumer Group 1	Nom du groupe de consommateurs.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
PageCount	Integer	4	Nombre total de pages renvoyées.
PageSize	Integer	2	Nombre d'entrées renvoyées par page.
RequestId	String	73B9DF43-7780-47DE-8BED-077729D28BD2	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : l'appel a réussi. false : l'appel a échoué.
Total	Integer	8	Nombre total d'entrées.

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupList
&CurrentPage=1
&PageSize=2
&Fuzzy=true
&GroupName=Consumer groups of the A type
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

<QueryConsumerGroupListResponse>
    <PageSize>2</PageSize>
    <PageCount>4</PageCount>
    <CurrentPage>1</CurrentPage>
    <Total>8</Total>
    <Data>
        <ConsumerGroupDTO>
            <GroupId>nJRaJPn5U1JITGf******</GroupId>
            <GroupName>Consumer Group 1</GroupName>
            <CreateTime>2020-05-29T03:37:56.000Z</CreateTime>
        </ConsumerGroupDTO>
        <ConsumerGroupDTO>
            <GroupId>qJRaJPndeefwgef******</GroupId>
            <GroupName>Consumer Group 2</GroupName>
            <CreateTime>2020-01-17T07:27:01.000Z</CreateTime>
        </ConsumerGroupDTO>
    </Data>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</QueryConsumerGroupListResponse>

Format JSON

{
    "PageSize": 2,
    "PageCount": 4,
    "CurrentPage": 1,
    "Total": 8,
    "Data": {
        "ConsumerGroupDTO": [
            {
                "GroupId": "nJRaJPn5U1JITGf******",
                "GroupName": "Consumer Group 1",
                "CreateTime": "2020-05-29T03:37:56.000Z"
            },
            {
                "GroupId": "qJRaJPndeefwgef******",
                "GroupName": "Consumer Group 2",
                "CreateTime": "2020-01-17T07:27:01.000Z"
            }
        ]
    },
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}

Codes d'erreur

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