DescribeInstance - Web Application Firewall - Centre de documentation Alibaba Cloud

Obtient les détails d'une instance WAF dans le compte Alibaba Cloud actuel.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

yundun-waf:DescribeInstance

get

*Toutes les ressources.

*

acs:ResourceGroupId

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Non	La région où réside l'instance WAF. Valeurs valides :	cn-hangzhou
ResourceManagerResourceGroupId	string	Non	L'identifiant du groupe de ressources Alibaba Cloud.	rg-acfm***q

Éléments de réponse

Élément	Type	Description	Exemple
	object
Status	integer	L'état actuel de l'instance. Valeurs valides : 1 : Normal. 2 : Expiré. 3 : Libéré.	1
Details	object	Les détails de l'instance.
DefenseObjectInGroupMaxCount	integer	Le nombre maximal d'objets de protection qu'un groupe de protection peut contenir.	100
Tamperproof	boolean	Indique si la protection contre la falsification de pages Web est prise en charge. Valeurs valides :	true
BotApp	string	Indique si la protection spécifique au scénario contre les robots d'exploration d'applications est prise en charge. Valeurs valides : true : Prise en charge. false : Non prise en charge.	true
IpBlacklistRuleInTemplateMaxCount	integer	Le nombre maximal de règles de protection qu'un seul modèle de liste noire peut contenir.	100
WhitelistRuleCondition	string	Les champs de correspondance pour les règles de liste blanche. Pour plus d'informations, reportez-vous à la description du paramètre conditions de règle de liste blanche (whitelist) dans CreateDefenseRule.	URL
CustomRuleCondition	string	Les conditions de correspondance pour les règles personnalisées. Pour plus d'informations, reportez-vous à la description du paramètre conditions de règle personnalisée (custom_acl) dans CreateDefenseRule.	URL
CustomResponse	boolean	Indique si les réponses personnalisées sont prises en charge. Valeurs valides :\n- true : Pris en charge.\n\n- false : Non pris en charge.	true
HttpPorts	string	La plage de ports HTTP disponibles. Pour plus d'informations, reportez-vous à Ports pris en charge par WAF.	80
Gslb	boolean	Indique si la répartition de charge globale des serveurs (GSLB) est prise en charge. Valeurs valides :	true
Ipv6	boolean	Indique si IPv6 est pris en charge. Valeurs valides :	true
Bot	boolean	Indique si la gestion des robots est prise en charge. Valeurs valides :	true
CustomRule	boolean	Indique si les règles personnalisées sont prises en charge. Valeurs valides :\n- true : Prise en charge.\n\n- false : Non prise en charge.	true
IpBlacklist	boolean	Indique si la liste noire d'adresses IP est prise en charge. Valeurs valides : true : prise en charge. false : non prise en charge.	true
CnameResourceMaxCount	integer	Le nombre maximal de CNAME pouvant être ajoutés.	1000
BackendMaxCount	integer	Le nombre maximal d'adresses IP d'origine pouvant être configurées.	20
ExclusiveIp	boolean	Indique si les adresses IP exclusives sont prises en charge. Valeurs valides :	true
CustomResponseRuleInTemplateMaxCount	integer	Le nombre maximal de règles de protection qu'un seul modèle de réponse personnalisée peut contenir.	100
IpBlacklistIpInRuleMaxCount	integer	Le nombre maximal d'adresses IP pouvant être ajoutées à une règle de liste noire.	200
AclRuleMaxIpCount	integer	Le nombre maximal d'adresses IP pouvant être ajoutées au contenu de correspondance. Pour plus d'informations sur le contenu de correspondance, reportez-vous à Description des conditions de correspondance.	100
BotTemplateMaxCount	integer	Le nombre maximal de modèles de protection de gestion des robots pouvant être configurés.	50
DefenseGroupMaxCount	integer	Le nombre maximal de groupes de protection pouvant être configurés.	100
VastIpBlacklistInFileMaxCount	integer	Le nombre maximal d'adresses IP pouvant être importées dans la liste noire d'adresses IP en une seule importation en masse.	2000
AntiScanTemplateMaxCount	integer	Le nombre maximal de modèles de protection contre les analyses pouvant être configurés.	20
WhitelistLogical	string	Les opérateurs logiques pour les règles de liste blanche. Pour plus d'informations, reportez-vous à la description du paramètre conditions de règle de liste blanche (whitelist) dans CreateDefenseRule.	contain
CustomRuleTemplateMaxCount	integer	Le nombre maximal de modèles de règles personnalisées pouvant être configurés.	20
TamperproofTemplateMaxCount	integer	Le nombre maximal de modèles de protection contre la falsification de pages Web pouvant être configurés.	50
IpBlacklistTemplateMaxCount	integer	Le nombre maximal de modèles de liste noire pouvant être configurés.	20
HttpsPorts	string	La plage de ports HTTPS disponibles. Pour plus d'informations, reportez-vous à Ports pris en charge par WAF.	443
DlpTemplateMaxCount	integer	Le nombre maximal de modèles de prévention des fuites d'informations pouvant être configurés.	50
CustomRuleRatelimitor	string	L'objet de limitation de débit pour les règles personnalisées.	header
DefenseObjectMaxCount	integer	Le nombre maximal d'objets de protection pouvant être configurés.	20000
Dlp	boolean	Indique si la prévention des fuites de données est prise en charge. Valeurs valides : true : Prise en charge. false : Non prise en charge.	true
DefenseObjectInTemplateMaxCount	integer	Le nombre maximal d'objets de protection pouvant être associés à un seul modèle.	100
CustomRuleAction	string	Les chaînes incluses dans les règles personnalisées.	block
TamperproofRuleInTemplateMaxCount	integer	Le nombre maximal de règles de protection qu'un seul modèle de protection contre la falsification de pages Web peut contenir.	50
DlpRuleInTemplateMaxCount	integer	Le nombre maximal de règles de protection qu'un seul modèle de prévention des fuites d'informations peut contenir.	50
WhitelistTemplateMaxCount	integer	Le nombre maximal de modèles de liste blanche pouvant être configurés.	20
MajorProtection	boolean	Indique si la protection des événements critiques est prise en charge. Valeurs valides : true : Prise en charge. false : Non prise en charge.	true
BaseWafGroupRuleTemplateMaxCount	integer	Le nombre maximal de modèles de règles de protection de base pouvant être configurés.	20
BotWeb	string	Indique si la protection spécifique aux scénarios contre les robots d'exploration Web est prise en charge. Valeurs valides :\n- true : Prise en charge.\n- false : Non prise en charge.	true
CustomRuleInTemplateMaxCount	integer	Le nombre maximal de règles de protection qu'un seul modèle de règle personnalisée peut contenir.	100
VastIpBlacklistInOperationMaxCount	integer	Le nombre maximal d'adresses IP pouvant être ajoutées à la liste noire d'adresses IP en une seule opération de page.	500
WhitelistRuleInTemplateMaxCount	integer	Le nombre maximal de règles de protection qu'un seul modèle de liste blanche peut contenir.	100
AntiScan	boolean	Indique si la protection contre les analyses est prise en charge. Valeurs valides :	true
CustomResponseTemplateMaxCount	integer	Le nombre maximal de modèles de réponse personnalisés pouvant être configurés.	20
BaseWafGroupRuleInTemplateMaxCount	integer	Le nombre maximal de règles de protection pouvant être incluses dans un seul modèle de règles de protection de base.	100
MajorProtectionTemplateMaxCount	integer	Le nombre maximal de modèles de protection contre les événements critiques pouvant être configurés.	20
BaseWafGroup	boolean	Indique si les règles de protection de base sont prises en charge. Valeurs valides : true : Pris en charge. false : Non pris en charge.	true
Whitelist	boolean	Indique si la liste blanche d'adresses IP est prise en charge. Valeurs valides : true : Pris en charge. false : Non pris en charge.	true
LogService	boolean	Indique si le service de journalisation est pris en charge. Valeurs valides :	true
VastIpBlacklistMaxCount	integer	Le nombre maximal d'entrées de liste noire d'adresses IP qu'un seul utilisateur peut configurer.	50000
FreeQps	integer	La valeur de QPS gratuite incluse dans le plan d'abonnement. Pour plus d'informations, consultez Éditions de WAF 3.0. Remarque Ce paramètre n'a aucune utilité pratique pour les instances à l'usage.	1000
ExtendQps	integer	La valeur QPS étendue de l'instance par abonnement. Pour plus d'informations, consultez Éditions de WAF 3.0.\n> Ce paramètre ne s'applique pas aux instances à l'usage.	10000
ElasticQps	integer	La valeur de QPS extensible pour l'instance par abonnement avec facturation à la demande pour la capacité extensible. Pour plus d'informations, consultez Éditions de WAF 3.0. Remarque Ce paramètre n'a aucune signification pratique pour les instances à la demande.	2000
QpsBillingCap	integer	Le seuil de protection de facturation QPS pour l'édition à la demande. Pour plus d'informations, consultez Protection de la facturation du trafic pour le mode à la demande.\n> Ce paramètre n'a aucune signification pratique pour les instances à abonnement.	2000
HybridCloud	boolean	Indique si le cloud hybride est activé.	true
HybridCloudNodeExtend	integer	Le nombre de nœuds étendus de cloud hybride.	3
Apisec	boolean	Indique si la sécurité des API est activée.	false
AgenticApisec	boolean	Indique si la sécurité des API agentiques est activée.	true
ResourceDirectory	boolean	Indique si la fonctionnalité de gestion multi-comptes est prise en charge.	true
RequestId	string	L'identifiant de la requête.	66A98669-CC6E-4F3E-80A6-3014697B11AE
EndTime	integer	L'heure d'expiration de l'instance. La valeur est un horodatage UNIX. Unité : millisecondes. Format : ms.	4809859200000
InstanceId	string	L'identifiant de l'instance WAF.	waf-cn-xxx
InDebt	string	Indique si l'instance actuelle présente un retard de paiement. Valeurs valides :	1
StartTime	integer	L'heure d'achat. La valeur est un horodatage UNIX en millisecondes.	1668496310000
RegionId	string	La région où réside l'instance WAF. Valeurs valides : cn-hangzhou : la Chine continentale. ap-southeast-1 : en dehors de la Chine continentale.	cn-hangzhou
PayType	string	Le mode de facturation de l'instance. Valeurs valides :	POSTPAY
Edition	string	L'édition WAF.	default_version
ProcessStatus	string	L'état d'exécution de l'instance. Valeurs valides : commodity_converting : le produit est en cours de conversion. commodity_convert_check_failed : la vérification de la conversion du produit a échoué. commodity_convert_process_failed : la conversion du produit a échoué. order_create_failed : la création de la commande a échoué. order_pending_payment : la commande est en attente de paiement.	order_pending_payment

Exemples

JSON format

{
  "Status": 1,
  "Details": {
    "DefenseObjectInGroupMaxCount": 100,
    "Tamperproof": true,
    "BotApp": "true",
    "IpBlacklistRuleInTemplateMaxCount": 100,
    "WhitelistRuleCondition": "URL",
    "CustomRuleCondition": "URL",
    "CustomResponse": true,
    "HttpPorts": "80",
    "Gslb": true,
    "Ipv6": true,
    "Bot": true,
    "CustomRule": true,
    "IpBlacklist": true,
    "CnameResourceMaxCount": 1000,
    "BackendMaxCount": 20,
    "ExclusiveIp": true,
    "CustomResponseRuleInTemplateMaxCount": 100,
    "IpBlacklistIpInRuleMaxCount": 200,
    "AclRuleMaxIpCount": 100,
    "BotTemplateMaxCount": 50,
    "DefenseGroupMaxCount": 100,
    "VastIpBlacklistInFileMaxCount": 2000,
    "AntiScanTemplateMaxCount": 20,
    "WhitelistLogical": "contain",
    "CustomRuleTemplateMaxCount": 20,
    "TamperproofTemplateMaxCount": 50,
    "IpBlacklistTemplateMaxCount": 20,
    "HttpsPorts": "443",
    "DlpTemplateMaxCount": 50,
    "CustomRuleRatelimitor": "header",
    "DefenseObjectMaxCount": 20000,
    "Dlp": true,
    "DefenseObjectInTemplateMaxCount": 100,
    "CustomRuleAction": "block",
    "TamperproofRuleInTemplateMaxCount": 50,
    "DlpRuleInTemplateMaxCount": 50,
    "WhitelistTemplateMaxCount": 20,
    "MajorProtection": true,
    "BaseWafGroupRuleTemplateMaxCount": 20,
    "BotWeb": "true",
    "CustomRuleInTemplateMaxCount": 100,
    "VastIpBlacklistInOperationMaxCount": 500,
    "WhitelistRuleInTemplateMaxCount": 100,
    "AntiScan": true,
    "CustomResponseTemplateMaxCount": 20,
    "BaseWafGroupRuleInTemplateMaxCount": 100,
    "MajorProtectionTemplateMaxCount": 20,
    "BaseWafGroup": true,
    "Whitelist": true,
    "LogService": true,
    "VastIpBlacklistMaxCount": 50000,
    "FreeQps": 1000,
    "ExtendQps": 10000,
    "ElasticQps": 2000,
    "QpsBillingCap": 2000,
    "HybridCloud": true,
    "HybridCloudNodeExtend": 3,
    "Apisec": false,
    "AgenticApisec": true,
    "ResourceDirectory": true
  },
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "EndTime": 4809859200000,
  "InstanceId": "waf-cn-xxx",
  "InDebt": "1",
  "StartTime": 1668496310000,
  "RegionId": "cn-hangzhou",
  "PayType": "POSTPAY",
  "Edition": "default_version",
  "ProcessStatus": "order_pending_payment"
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.