Paramètres communs - Web Application Firewall - Centre de documentation Alibaba Cloud

Toutes les requêtes et réponses d'API WAF partagent un ensemble de paramètres communs. Cette rubrique décrit ces paramètres et présente la structure d'une requête et d'une réponse correctement formatées.

Paramètres de requête communs

Incluez les paramètres suivants dans chaque requête d'API.

Paramètre	Type	Obligatoire	Description
Format	String	Non	Format de la réponse. Valeurs autorisées : JSON, XML. Valeur par défaut : XML.
Version	String	Oui	Version de l'API au format AAAA-MM-JJ. Définissez la valeur sur `2019-09-10`.
AccessKeyId	String	Oui	Votre ID AccessKey.
Signature	String	Oui	Chaîne de signature de 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` (UTC). Exemple : `2013-01-10T12:00:00Z` correspond au 10 janvier 2013 à 20 h 00 min 00 s (UTC+8).
SignatureVersion	String	Oui	Version de l'algorithme de signature. Définissez la valeur sur `1.0`.
SignatureNonce	String	Oui	Chaîne aléatoire unique empêchant les attaques par rejeu. Utilisez une valeur différente pour chaque requête.
ResourceOwnerAccount	String	Non	Compte Alibaba Cloud propriétaire de la ressource à accéder.

Exemple de requête

https://wafopenapi.cn-hangzhou.aliyuncs.com/?Action=DescribeDomainNames
&Region=cn
&InstanceId=waf_elasticity-cn-0xldbqtm005
&Timestamp=2013-01-10T12:00:00Z
&Format=xml
&AccessKeyId=********
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2019-09-10
&SignatureVersion=1.0
&Signature=Signature

Paramètres de réponse communs

Les réponses des API WAF respectent les conventions HTTP standard :

2xx : l'appel a réussi.
4xx ou 5xx : l'appel a échoué.

Chaque réponse inclut un paramètre RequestId, que l'appel ait réussi ou non. Les réponses sont renvoyées aux formats JSON ou XML. Le format par défaut est XML ; pour le modifier, définissez le paramètre de requête Format.

Exemples de réponses

Format XML

<?xml version="1.0" encoding="utf-8"?>
<!--Result root node-->
<InterfaceNameResponse>
    <!--Request tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--Return result data-->
</InterfaceNameResponse>

Format JSON

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