BatchQuerySessionByClientIds - - Centre de documentation Alibaba Cloud

Limites

L'opération BatchQuerySessionByClientIds prend en charge un maximum de 100 requêtes par seconde (QPS). Pour plus d'informations, consultez la rubrique Limites de QPS.
Chaque appel à l'opération BatchQuerySessionByClientIds permet d'interroger l'état de connexion des clients ApsaraMQ for MQTT correspondant à un maximum de 10 ID client.

Remarque

Chaque appel réussi à l'opération

BatchQuerySessionByClientIds

est comptabilisé comme une transaction de message par seconde (TPS). Par conséquent, cet appel est facturé. Pour plus d'informations, consultez la rubrique

Facturation

.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer pour plus de commodité. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	BatchQuerySessionByClientIds	Opération à effectuer. Définissez la valeur sur BatchQuerySessionByClientIds.
ClientIdList.N	RepeatList	Yes	ClientIdList.1	Numéro de série du client ApsaraMQ for MQTT. La valeur N indique le Nième ID client. Remarque Vous pouvez interroger par lot l'état des clients ApsaraMQ for MQTT correspondant à un maximum de 10 ID client en une seule requête. La plage de valeurs de N est comprise entre 1 et 10.
InstanceId	String	Yes	post-cn-0pp12gl****	ID de l'instance ApsaraMQ for MQTT. La valeur doit correspondre à l'ID d'instance utilisé sur le client ApsaraMQ for MQTT. Vous pouvez obtenir l'ID d'instance depuis la page instance details de la console ApsaraMQ for MQTT.
RegionId	String	Yes	cn-hangzhou	ID de région de l'instance ApsaraMQ for MQTT.

Remarque

Pour plus d'informations sur ces paramètres, consultez les rubriques

Paramètres communs

et

Endpoints

.

Paramètres de réponse

Parameter	Type	Example	Description
OnlineStatusList	Array of OnlineStatusList		Liste des états de tous les clients ApsaraMQ for MQTT interrogés.
ClientId	String	GID_test@0001	ID d'un client ApsaraMQ for MQTT. Pour plus d'informations sur les ID client, consultez la rubrique Termes.
OnlineStatus	Boolean	true	Indique si le client ApsaraMQ for MQTT est connecté à une instance ApsaraMQ for MQTT. Valeurs possibles : true: Connecté false: Déconnecté
RequestId	String	63309FDB-ED6C-46AE-B31C-A172FBA0****	ID de la requête.

Exemples

Exemple de requête

http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/? Action=BatchQuerySessionByClientIds
&ClientIdList.1=ClientIdList.1
&InstanceId=post-cn-0pp12gl****
&RegionId=cn-hangzhou
&<Common request parameters>

Exemple de réponse réussie

Format XML

<BatchQuerySessionByClientIdsResponse>
    <OnlineStatusList>
            <ClientId>GID_test@0001</ClientId>
            <OnlineStatus>true</OnlineStatus>
    </OnlineStatusList>
    <OnlineStatusList>
            <ClientId>GID_test@0002</ClientId>
            <OnlineStatus>false</OnlineStatus>
    </OnlineStatusList>
    <RequestId>63309FDB-ED6C-46AE-B31C-A172FBA0****</RequestId>
</BatchQuerySessionByClientIdsResponse>

Format JSON

{
    "OnlineStatusList": [
        {
            "ClientId": "GID_test@0001",
            "OnlineStatus": true
        },
        {
            "ClientId": "GID_test@0002",
            "OnlineStatus": false
        }
    ],
    "RequestId": "63309FDB-ED6C-46AE-B31C-A172FBA0****"
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
404	ApiNotSupport	The specified API is not supported.	Le message d'erreur renvoyé indique que l'opération actuelle n'est pas prise en charge.
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.	Le message d'erreur renvoyé indique que les informations de compte du jeton Security Token Service (STS) n'ont pas pu être analysées.
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.	Le message d'erreur renvoyé indique que la vérification des autorisations de l'instance a échoué. Vérifiez la propriété et la politique d'autorisation de l'instance ApsaraMQ for MQTT.
500	InternalError	An error occurred while processing your request. Try again later.	Le message d'erreur renvoyé indique qu'une erreur interne s'est produite sur l'instance ApsaraMQ for MQTT. Veuillez réessayer.
400	ParameterCheckFailed	An error occurred while validating the parameters. The parameters may be missing or invalid.	Le message d'erreur renvoyé indique que la vérification des paramètres a échoué. Ce paramètre est peut-être manquant ou invalide.
400	PermissionCheckFailed	An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.	Le message d'erreur renvoyé indique que la vérification des autorisations de ressource a échoué. Vérifiez les autorisations et les politiques d'autorisation de l'instance, du topic et de l'ID de groupe.
500	SystemOverFlow	An error occurred while processing your request. Please try again.	Le message d'erreur renvoyé indique que la limitation du débit est déclenchée. Veuillez réessayer.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.	Le message d'erreur renvoyé indique que la vérification des paramètres a échoué. Ce paramètre est peut-être manquant ou invalide.

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