Cette opération renvoie les détails de l'instance Web Application Firewall (WAF) associée à votre compte Alibaba Cloud, notamment son ID, son édition, son état et sa date d'expiration.
Notes d'utilisation
Cette opération permet de récupérer les informations relatives à l'instance WAF, y compris son ID, sa version, son état et sa date d'expiration.
Limites
Vous pouvez effectuer jusqu'à 50 appels par seconde par compte. Le dépassement de cette limite déclenche une limitation du débit et peut affecter votre service.
Débogage
Paramètres de requête
| Paramètre | Type | Obligatoire | Exemple | Description |
|---|---|---|---|---|
| Action | String | Oui | DescribeInstanceInfo | Opération à exécuter. Définissez la valeur sur DescribeInstanceInfo. |
| InstanceId | String | Non | waf-cn-tl32ast\\\\ | ID de l'instance WAF. Si vous omettez ce paramètre, l'opération renvoie toutes les instances WAF en Chine continentale ou toutes les instances WAF hors de Chine continentale. |
| ResourceGroupId | String | Non | rg-atstuj3rtop\\\\ | ID du groupe de ressources auquel appartient l'instance WAF dans Resource Management. Si vous omettez ce paramètre, le groupe de ressources par défaut est utilisé. |
Pour connaître les paramètres de requête communs, consultez la rubrique Paramètres communs.
Éléments de réponse
| Paramètre | Type | Exemple | Description |
|---|---|---|---|
| RequestId | String | D7861F61-5B61-46CE-A47C-6B19160D5EB0 | ID de la requête. |
| InstanceInfo | Object | Détails de l'instance WAF. | |
| InstanceInfo.PayType | Integer | 1 | État d'activation de WAF. Valeurs possibles :
|
| InstanceInfo.InstanceId | String | waf-cn-tl32ast\*\*\*\* | ID de l'instance WAF. Remarque Non renvoyé si PayType est égal à 0. |
| InstanceInfo.Version | String | version_pro_chinaversion_pro_china | Édition de l'instance WAF. Remarque Non renvoyé si PayType est égal à 0. Valeurs valides pour les comptes créés sur le site International : version_pro_china : instance WAF Pro en Chine continentale. version_business_china : instance WAF Business en Chine continentale. version_enterprise_china : instance WAF Enterprise en Chine continentale. version_exclusive_china : instance WAF Exclusive en Chine continentale. version_hybrid_cloud_standard_china : instance Hybrid Cloud WAF en Chine continentale. version_pro_china : instance WAF Pro hors de Chine continentale. version_business : instance WAF Business hors de Chine continentale. version_enterprise : instance WAF Enterprise hors de Chine continentale. version_exclusive : instance WAF Exclusive hors de Chine continentale. version_hybrid_cloud_standard : instance Hybrid Cloud WAF hors de Chine continentale. Si la valeur renvoyée ne figure pas dans cette liste, vérifiez que votre compte a été créé sur le site International. La liste précédente contient toutes les éditions des instances WAF pour les comptes créés sur le site International. Si la version renvoyée ne figure pas dans la liste, vérifiez si votre compte est créé sur le site International.
|
| InstanceInfo.Status | Integer | 1 | Indique si l'instance WAF a expiré. Remarque Non renvoyé si PayType est égal à 0. Valeurs possibles : 0 : L'instance a expiré. 1 : L'instance n'a pas expiré. |
| InstanceInfo.EndDate | Long | 1512921600 | Date d'expiration de l'instance WAF, exprimée sous forme d'horodatage UNIX en secondes. Remarque Non renvoyé si PayType est égal à 0. |
| InstanceInfo.Region | String | cn | Région de l'instance WAF. Remarque Non renvoyé si PayType est égal à 0. Valeurs possibles : cn : Chine continentale. cn-hongkong : Hors de Chine continentale. |
| InstanceInfo.InDebt | Integer | 1 | Indique si l'instance WAF présente des impayés. Remarque Non renvoyé si PayType est égal à 0. Valeurs possibles : 0 : L'instance présente des impayés. 1 : L'instance ne présente aucun impayé. |
| InstanceInfo.SubscriptionType | String | Subscription | Méthode de facturation de l'instance WAF. La valeur est fixée à Subscription. Remarque Non renvoyé si PayType est égal à 0. Méthode de facturation de l'instance WAF : la valeur est fixée à Subscription. |
| InstanceInfo.Trial | Integer | 1 | Indique si une instance WAF d'essai gratuit est activée dans le compte Alibaba Cloud. Valeurs possibles : 0 : Non. 1 : Oui. Remarque Renvoyé uniquement si une instance WAF d'essai gratuit est activée. |
| InstanceInfo.RemainDay | Integer | 1 | Nombre de jours restants avant la fin de la période d'essai gratuit. Remarque Renvoyé uniquement si Trial est égal à 1. |
Exemples
Exemple de requête
http(s)://[Endpoint]/?Action=DescribeInstanceInfo
&<Common request parameters>
Exemple de réponse en cas de succès
Format XML
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeInstanceInfoResponse>
<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
<InstanceInfo>
<Status>1</Status>
<EndDate>1512921600</EndDate>
<Version>version_3</Version>
<Region>cn</Region>
<PayType>1</PayType>
<InDebt>1</InDebt>
<InstanceId>waf-cn-tl32ast****</InstanceId>
<SubscriptionType>Subscription</SubscriptionType>
</InstanceInfo>
</DescribeInstanceInfoResponse>
Format JSON
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
"InstanceInfo" : {
"Status" : 1,
"EndDate" : 1512921600,
"Version" : "version_3",
"Region" : "cn",
"PayType" : 1,
"InDebt" : 1,
"InstanceId" : "waf-cn-tl32ast****",
"SubscriptionType" : "Subscription"
}
}
Codes d'erreur
Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.