CreateDefenseTemplate - Web Application Firewall - Centre de documentation Alibaba Cloud

Crée un modèle de protection.

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:CreateDefenseTemplate

create

*Toutes les ressources.

*

acs:ResourceGroupId

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant de l'instance WAF. Remarque Vous pouvez appeler DescribeInstance pour obtenir l'identifiant de l'instance WAF actuelle.	waf_cdnsdf3****
TemplateName	string	Oui	Le nom du modèle de protection à créer. Le nom doit comporter de 1 à 255 caractères et peut contenir des caractères chinois, des lettres, des chiffres, des traits de soulignement (_), des points (.) et des traits d'union (-). Remarque Les noms de modèles doivent être uniques au sein du même scénario de protection (DefenseScene).	test221
TemplateType	string	Oui	Le type de modèle du modèle de protection à créer. Valeurs valides : user_default : protection par défaut. user_custom : protection personnalisée.	user_default
TemplateStatus	integer	Oui	L'état du modèle de protection à créer. Valeurs valides : 0 : Désactivé. 1 : Activé.	1
DefenseScene	string	Oui	Le scénario de protection. Pour plus d'informations, consultez le paramètre DefenseScene dans CreateDefenseRule.	waf_group
TemplateOrigin	string	Oui	La source du modèle de protection à créer. Définissez la valeur sur custom, ce qui indique une définition par l'utilisateur.	custom
DefenseSubScene	string	Non	Le sous-scénario du modèle de protection. Ce paramètre est pris en charge uniquement pour le scénario de gestion avancée des robots. Valeurs valides : app : Modèle de scénario d'application. web : Modèle de scénario web. bot_custom_acl : Modèle de règle personnalisée avancée.	web
Description	string	Non	La description du modèle de protection à créer.	test
RegionId	string	Non	Les informations détaillées du modèle, sous forme de chaîne au format JSON. Différentes paires clé-valeur représentent différents attributs de l'objet protégé. Pour plus d'informations, consultez la description de Detail. Remarque Ce paramètre s'applique uniquement à la nouvelle version de la protection de base (waf_base) et à la nouvelle version des scénarios de protection de gestion des robots (bot_manager). Ce paramètre est requis pour le scénario de protection de la nouvelle version de gestion des robots (bot_manager).	{"trafficFeature":"{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"}
ResourceManagerResourceGroupId	string	Non	Indique si le mode test à blanc doit être activé. Si vous ne spécifiez pas ce paramètre, une requête normale est envoyée. Valeurs valides : true : une requête de test à blanc est envoyée. Le système vérifie si la requête remplit les conditions d'exécution sans effectuer l'opération spécifiée. Si le test à blanc échoue, le code d'erreur correspondant est renvoyé. Si le test à blanc réussit, le code d'erreur Defense.Control.DryRunOperation est renvoyé. false : une requête normale est envoyée. L'opération spécifiée est effectuée après que la requête a passé la vérification.	false
UnbindResources	array	Non	La région où réside l'instance WAF. Valeurs valides : cn-hangzhou : la partie continentale de la Chine. ap-southeast-1 : en dehors de la partie continentale de la Chine.	cn-hangzhou
	string	Non	L'objet protégé à dissocier.	abc
UnbindResourceGroups	array	Non	L'identifiant du groupe de ressources Alibaba Cloud.	rg-acfm***q
	string	Non	Le groupe d'objets protégés à dissocier.	group1
		Non	Les objets protégés à dissocier lors de la création d'un modèle de protection par défaut. Utilisez le format ["XX1","XX2",……]. Remarque Ce paramètre prend effet uniquement lors de la création d'un modèle par défaut (lorsque TemplateType est défini sur user_default).
		Non	Les groupes d'objets protégés à dissocier lors de la création d'un modèle de protection par défaut. Utilisez le format ["group1","group2",……]. Remarque Ce paramètre prend effet uniquement lors de la création d'un modèle par défaut (lorsque TemplateType est défini sur user_default).

Description du paramètre Detail

Le contenu du paramètre Detail varie en fonction du scénario de protection (DefenseScene) du modèle de protection.

Nouvelle version de la protection de base Web (waf_base)

Description des paramètres

Nom	Type	Obligatoire	Exemple	Description
aiWhitelistStatus	integer	Non	1	L'état du moteur de liste blanche intelligente pour la nouvelle version de la protection de base. Valeurs valides : - 0 (par défaut) : Désactivé. - 1 : Activé.

Exemple

{
  "aiWhitelistStatus": 1
}

Nouvelle version de la gestion des robots (bot_manager)

Description des paramètres

Nom	Type	Obligatoire	Exemple	Description
trafficFeature	String	Non	{"global":1,"excludeStatus":1,"staticFile":".css,.js,.jpg,……"}	Les paramètres de la portée de protection du modèle de protection de gestion des robots, décrits au format de chaîne JSON. Ce paramètre est requis lorsque le scénario de protection (DefenseScene) est bot_manager. Pour plus d'informations, consultez Paramètres détaillés du paramètre trafficFeature.

Paramètres détaillés du paramètre trafficFeature

Nom	Type	Obligatoire	Exemple	Description
global	Integer	Oui	1	Indique si la portée de protection couvre l'ensemble du site. Valeurs valides : - 0 : Portée de protection personnalisée. Utilisez conditions pour spécifier les caractéristiques de trafic qui prennent effet. - 1 : Protection globale. Le modèle prend effet sur toutes les requêtes adressées à l'objet protégé.
excludeStatus	Integer	Non	1	Indique s'il faut exclure les ressources statiques. Les requêtes qui correspondent aux suffixes de fichiers statiques spécifiés dans staticFile n'entrent pas dans la protection contre les robots. Valeurs valides : - 0 : Les ressources statiques ne sont pas exclues. - 1 : Les ressources statiques sont exclues. Utilisez staticFile pour spécifier les suffixes de fichiers statiques à exclure.
staticFile	String	Non	.7z,.aac,.css,.js,.jpg,.png,.pdf,.zip,……	La liste des suffixes de fichiers statiques à exclure, représentée sous forme de chaîne séparée par des virgules (,). Chaque suffixe commence par un point (.). Configurez ce paramètre uniquement lorsque excludeStatus est défini sur 1.
conditions	Array	Non	[{"key":"URL","opValue":"not-contain","values":"test"}]	Les caractéristiques de trafic pour la portée de protection personnalisée, décrites au format de chaîne JSON. Ce paramètre ne peut être configuré que lorsque global est défini sur 0. Pour plus d'informations, consultez les paramètres du paramètre conditions dans Paramètres des règles de protection.

Exemple

{
  "trafficFeature": "{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"
}

Éléments de réponse

Élément	Type	Description	Exemple
	object	La structure de la réponse.
RequestId	string	L'identifiant de la requête.	F48ABDF7-D777-5F26-892A-57349765D7A9
TemplateId	integer	L'identifiant du modèle de protection.	2212

Exemples

JSON format

{
  "RequestId": "F48ABDF7-D777-5F26-892A-57349765D7A9",
  "TemplateId": 2212
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.