Toute requête et réponse de l'API KMS inclut un ensemble de paramètres communs. Cette rubrique répertorie ces paramètres, ainsi que leurs types, leur caractère obligatoire et les valeurs acceptées.
Paramètres de requête communs
Incluez ces paramètres dans chaque requête API.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| Format | String | Non | Format de la réponse. Valeurs valides : JSON (par défaut), XML. |
| Version | String | Oui | Numéro de version de l'API au format YYYY-MM-DD. Définissez la valeur sur 2016-01-20. |
| AccessKeyId | String | Oui | ID AccessKey associé à votre compte Alibaba Cloud. |
| Signature | String | Oui | Chaîne de signature pour la requête en cours. |
| SignatureMethod | String | Oui | Algorithme de signature. Définissez la valeur sur HMAC-SHA1. |
| Timestamp | String | Oui | Horodatage de la requête au format ISO 8601 : yyyy-MM-ddTHH:mm:ssZ. Il doit être exprimé en UTC. Par exemple, 2022-01-10T12:00:00Z correspond au 10 janvier 2022 à 20:00:00 (UTC+8). |
| SignatureVersion | String | Oui | Version de l'algorithme de signature. Définissez la valeur sur 1.0. |
Exemple de requête
https://kms.cn-hangzhou.aliyuncs.com/?Action=CreateKey
&Format=json
&Version=2016-01-20
&AccessKeyId=te****
&Signature=YlrFhyqDZQ1ThNYARrv3Ptaxqf****
&SignatureMethod=HMAC-SHA1
&Timestamp=2022-01-10T12:00:00Z
&SignatureVersion=1.0
Paramètres de réponse communs
Les réponses sont renvoyées au format JSON ou XML, conformément à la valeur du paramètre Format indiqué dans la requête. Le format par défaut est JSON.
Chaque réponse, qu'elle soit positive ou non, inclut un identifiant unique RequestId. Utilisez cette valeur lorsque vous contactez le support Alibaba Cloud.
Codes d'état HTTP
| Code d'état | Signification |
|---|---|
2xx |
La requête a abouti. |
4xx |
Échec de la requête dû à une erreur client. |
5xx |
Échec de la requête dû à une erreur serveur. |
Exemples de réponses
Format JSON
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
}
Format XML
<?xml version="1.0" encoding="utf-8"?>
<KMS>
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
</KMS>