Paramètres communs - - Centre de documentation Alibaba Cloud

Cette rubrique décrit les paramètres communs à toutes les requêtes et réponses d'API pour Message Queue for MQTT.

Paramètres de requête communs

Tableau 1. Tableau des paramètres de requête communs
Paramètre	Type	Obligatoire	Description
Format	String	Non	Format de la réponse. Valeurs valides : JSON XML
Version	String	Oui	Numéro de version de l'API. Spécifiez le numéro de version au format AAAA-MM-JJ. Valeurs valides : 2020-04-20
AccessKeyId	String	Oui	ID AccessKey de votre compte Alibaba Cloud. Pour savoir comment obtenir un ID AccessKey, consultez Obtenir une paire de clés AccessKey.
Signature	String	Oui	Chaîne de signature de la requête actuelle. Pour plus d'informations sur le calcul des signatures, consultez Méthode de signature.
SignatureMethod	String	Oui	Méthode de chiffrement de la chaîne de signature. Définissez la valeur sur HMAC-SHA1
Timestamp	String	Oui	Horodatage de la requête. Indiquez l'heure selon la norme ISO 8601, au format AAAA-MM-JJThh:mm:ssZ. L'heure doit être exprimée en UTC. Par exemple, utilisez 2013-01-10T12:00:00Z pour indiquer 20 h 00 min 00 s le 10 janvier 2013 (UTC+8).
SignatureVersion	String	Oui	Version de l'algorithme de chiffrement de la signature. Définissez la valeur sur 1,0
SignatureNonce	String	Oui	Nombre aléatoire unique utilisé pour empêcher les attaques par rejeu. Utilisez un nombre aléatoire unique pour chaque requête.
ResourceOwnerAccount	String	Non	Compte Alibaba Cloud auquel appartient la ressource à laquelle vous souhaitez accéder.

Exemples de requêtes

http://onsmqtt.[regionId].aliyuncs.com/?Action=[ApiName]
&TimeStamp=2020-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE****
&Version=2020-04-20
&SignatureVersion=1.0
&Signature=[Signature]

Paramètres de réponse communs

Les réponses d'API utilisent le format de réponse HTTP. Une réponse peut être renvoyée au format JSON ou XML. Vous pouvez spécifier le format de réponse dans la requête. Le format de réponse par défaut est XML. Chaque réponse renvoie un identifiant de requête unique (RequestId), que l'appel aboutisse ou non.

Un code d'état HTTP 2xx indique un appel réussi.
Un code d'état HTTP 4xx ou 5xx indique un échec de l'appel.

Exemples de réponses réussies

Chaque réponse renvoie les paramètres de réponse et un ID de requête pour un appel réussi. Dans une réponse réussie, le code d'état HTTP est 2xx.

Format XML

<?xml version="1.0" encoding="utf-8"?> 
    <!--Root node of the response-->
    <Operation name+Response>
        <!--Returned request tag-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--Returned data-->
    </Operation name+Response>

Format JSON

{
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*Returned data*/
    }

Exemples de réponses d'erreur

Si une erreur se produit lors de l'appel d'une opération, une réponse d'erreur contenant un code d'erreur, un message d'erreur et un ID de requête est renvoyée. Dans une réponse d'erreur, le code d'état HTTP est 4xx ou 5xx. Résolvez les problèmes en vous basant sur les codes d'erreur. Pour plus d'informations, consultez Codes d'erreur. Si vous ne parvenez pas à résoudre les problèmes à l'aide des codes d'erreur, contactez ApsaraMQ for MQTT support technique.

Format XML

<?xml version="1.0" encoding="UTF-8"?><!--Root node of the response-->
<Error>
    <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!--Request ID-->
    <Code>MissingParameter.CommandId</Code> <!--Error code-->
    <Message>The input parameter "CommandId" that is mandatory for processing this request is not supplied.</Message> <!--Error message-->
</Error>

Format JSON

{
    "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* Request ID */
    "Code": "MissingParameter.CommandId", /* Error code */
    "Message": "The input parameter "CommandId" that is mandatory for processing this request is not supplied." /* Error message */
}