Paramètres communs - IoT Platform - Centre de documentation Alibaba Cloud

Cette rubrique décrit les paramètres de requête et de réponse communs des API IoT Platform.

Paramètres de requête communs

Vous devez inclure les paramètres de requête communs dans toutes les requêtes d'API IoT Platform.

Parameter	Type	Required	Description
Format	String	No.	Format de la réponse. Valeurs possibles : JSON et XML. Valeur par défaut : XML.
Version	String	Yes	Numéro de version de l'API. La valeur doit respecter le format `YYYY-MM-DD`. Valeurs possibles : `2018-01-20`.
AccessKeyId	String	Yes	ID AccessKey fourni par Alibaba Cloud. Pour créer ou afficher une paire AccessKey, connectez-vous à la Alibaba Cloud Management Console, placez le pointeur sur la photo de profil, puis cliquez sur AccessKey Management. Sur la page Paire de clés d'accès, affichez ou créez une paire AccessKey.
Signature	String	Yes	Chaîne de signature de la requête actuelle. Pour plus d'informations sur le calcul des signatures, consultez la section Méthode de signature.
SignatureMethod	String	Yes	Méthode de chiffrement de la chaîne de signature. Définissez la valeur sur HMAC-SHA1.
Timestamp	String	Yes	Horodatage de la requête. Spécifiez l'heure selon la norme ISO 8601 en UTC. Format : `YYYY-MM-DDThh:mm:ssZ`. Par exemple, définissez ce paramètre sur `2016-01-04T12:00:00Z`, ce qui correspond au 4 janvier 2016 à 20 h 00 min 00 s (UTC+8).
SignatureVersion	String	Yes	Numéro de version de l'algorithme de chiffrement de la signature. Définissez la valeur sur 1,0.
SignatureNonce	String	Yes	Nombre aléatoire unique utilisé pour prévenir les attaques par rejeu. Utilisez un nombre différent pour chaque requête.
RegionId	String	Yes	ID de la région où résident vos appareils. La région doit être identique à celle spécifiée dans la console IoT Platform. Exemple : cn-shanghai. Pour plus d'informations sur les ID des régions prises en charge par IoT Platform, consultez la section Régions prises en charge.

Exemple :

https://iot.cn-shanghai.aliyuncs.com/
?Format=XML
&Version=2018-01-20
&Signature=Pc5WB***
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=234***
&Timestamp=2018-05-20T12:00:00Z
&RegionId=cn-shanghai

Paramètres de réponse communs

Les réponses aux API utilisent le format de réponse HTTP : un code d'état 2xx indique un appel réussi, tandis qu'un code 4xx ou 5xx indique un échec. Les réponses peuvent être renvoyées au format JSON ou XML. Vous pouvez spécifier le format de réponse dans la requête. Le format par défaut est XML.

Chaque réponse inclut un ID de requête unique, indiqué par le paramètre RequestId, que l'appel soit réussi ou non.

Exemples de réponses réussies

Format XML

API IoT Platform version 2018-01-20

<?xml version="1.0" encoding="UTF-8"?>
<!--Result root node-->
<Operation name + Response>
    <!--Return request tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--Return result data-->
</API 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 d'API, aucune donnée de résultat n'est renvoyée. Utilisez le code d'erreur pour identifier la cause du problème.

En cas d'erreur lors de l'appel d'une opération d'API, un code d'état HTTP 4XX ou 5XX est renvoyé. Le message renvoyé contient le code d'erreur spécifique et le message d'erreur. Il inclut également un ID de requête global unique, renvoyé dans le paramètre RequestId. Si vous ne parvenez pas à identifier l'erreur, contactez le service client Alibaba Cloud ou soumettez un ticket en fournissant votre ID de requête.
- Format XML
```
<?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <Code>UnsupportedOperation</Code>
   <Message>The specified action is not supported.</Message>
</Error>
```
- Format JSON
```
{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}
```