Les paramètres communs comprennent les paramètres de requête communs et les paramètres de réponse communs.
Paramètres de requête communs
|
Nom |
Type |
Obligatoire |
Description |
|
Format |
String |
Non |
Format de la réponse. Valeurs possibles :
|
|
Version |
String |
Oui |
Numéro de version de l'API. Le format est |
|
AccessKeyId |
String |
Oui |
ID de votre AccessKey. Pour plus d'informations, consultez Créer une paire de clés d'accès. |
|
Signature |
String |
Oui |
Chaîne de signature de la requête. Pour plus d'informations, consultez Mécanisme de signature. |
|
SignatureMethod |
String |
Oui |
Algorithme de signature. Définissez la valeur sur HMAC-SHA1. |
|
Timestamp |
String |
Oui |
Horodatage de la requête. Il doit être exprimé en UTC et respecter le format ISO 8601 : YYYY-MM-DDThh:mm:ssZ. Par exemple, pour spécifier le 10 janvier 2013 à 20 h 00 min 00 s (UTC+8), définissez la valeur sur 2013-01-10T12:00:00Z. |
|
SignatureVersion |
String |
Oui |
Version de l'algorithme de signature. Définissez la valeur sur 1,0. |
|
SignatureNonce |
String |
Oui |
Nombre aléatoire unique utilisé pour prévenir les attaques par rejeu. Vous devez utiliser un nombre aléatoire différent pour chaque requête. |
Le code suivant illustre des paramètres de requête communs :
http://actiontrail.cn-hangzhou.aliyuncs.com
?SignatureVersion=1.0
&OssBucketName=yuanch****
&Name=CreateTest
&Format=JSON
&Timestamp=2015-12-01T07%3A04%3****
&Signature=iyEsE7vgGUWop7Term5HM48wzJ****
&AccessKeyId=QzW2********C21M
&SignatureMethod=HMAC-SHA1
&Version=2017-12-04
&RoleName=aliyunactiontraildefaultrole
&Action=CreateTrail
&SignatureNonce=c69b30de-97f9-11e5-afb0-7831c1c8****
&OssKeyPrefix=
Paramètres de réponse communs
Les réponses API suivent un format unifié. En cas de succès, la réponse est renvoyée au format XML ou JSON. Vous pouvez spécifier le format des données dans la requête. Le format par défaut est XML. Pour chaque appel d'API, un RequestId unique est renvoyé, que l'appel aboutisse ou non.
Un code d'état HTTP
2xxindique que l'appel a réussi.Un code d'état HTTP
4xxou5xxindique que l'appel a échoué.
Voici des exemples de paramètres de réponse communs :
-
Format XML
<?xml version="1.0" encoding="utf-8"?> <!--The root node of the result--> <APIName+Response> <!--The request tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--The response data--> </APIName+Response> -
Format JSON
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216" /*The response data*/ }