QuerySessionByClientId - - Centre de documentation Alibaba Cloud

Scénarios

L'opération QuerySessionByClientId permet généralement de suivre l'état d'exécution d'un client ApsaraMQ for MQTT connecté et de résoudre les problèmes liés à ce client en fonction des résultats de la requête. Saisissez un ID client pour vérifier l'état de connexion ainsi que l'adresse IP du client ApsaraMQ for MQTT.

Pour plus d'informations sur les ID clients, consultez la rubrique Termes.

Limites

L'opération QuerySessionByClientId prend en charge un maximum de 500 requêtes par seconde (QPS). Pour plus d'informations, consultez la rubrique Limites QPS.

Remarque

Chaque appel réussi à l'opération

QuerySessionByClientId

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

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QuerySessionByClientId	L'opération à effectuer. Définissez la valeur sur QuerySessionByClientId.
ClientId	String	Oui	GID_test@@@test	ID du client ApsaraMQ for MQTT à interroger.
InstanceId	String	Oui	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 Détails de l'instance dans la console ApsaraMQ for MQTT.
RegionId	String	Oui	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

Paramètre

Type

Exemple

Description

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

E4581CCF-62AF-44D9-B5B4-D1DBBC0E****

ID de la requête.

Exemples

Exemple de requête

http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/? Action=QuerySessionByClientId
&ClientId=GID_test@@@test
&InstanceId=post-cn-0pp12gl****
&RegionId=cn-hangzhou
&<Common request parameters>

Exemple de réponse réussie

Format XML

<QuerySessionByClientIdResponse>
        <OnlineStatus>true</OnlineStatus>
        <RequestId>E4581CCF-62AF-44D9-B5B4-D1DBBC0E****</RequestId>
</QuerySessionByClientIdResponse>

Format JSON

{
    "OnlineStatus": true,
    "RequestId": "E4581CCF-62AF-44D9-B5B4-D1DBBC0E****"
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
404	ApiNotSupport	The specified API is not supported.	L'opération actuelle n'est pas prise en charge.
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.	Échec de l'analyse des informations de compte du jeton Security Token Service (STS).
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.	Échec de la vérification des autorisations de l'instance. 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.	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.	Échec de la vérification des paramètres. Un 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.	Échec de la vérification des autorisations de ressource. 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.	La limitation de 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.	Échec de la vérification des paramètres. Un paramètre est peut-être manquant ou invalide.

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