CreateDefenseResource - Web Application Firewall - Centre de documentation Alibaba Cloud

Crée un objet protégé.

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

create

*DefenseResource.

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Resource	string	Non	Le nom de l'objet protégé. Remarque Seuls les objets protégés en mode de service cloud hybride prennent en charge les noms d'objets protégés personnalisés.	abctest.com
Product	string	Oui	Le nom du produit cloud. Valeurs valides : alb : Application Load Balancer (ALB). ecs : Elastic Compute Service (ECS). clb4 : accès à la couche 4 de Classic Load Balancer (CLB). clb7 : accès à la couche 7 de Classic Load Balancer (CLB). nlb : Network Load Balancer (NLB). waf : Web Application Firewall (WAF).	ecs
ResourceGroup	string	Non	Le nom du groupe de protection auquel l'objet protégé est ajouté. Ce paramètre est facultatif.	testGroup
ResourceOrigin	string	Oui	La source de l'objet protégé. Valeurs valides : custom : défini par l'utilisateur.	custom
Pattern	string	Oui	Le mode de protection de l'objet protégé. Valeurs valides : domain : protection basée sur le nom de domaine. multi_service : protection basée sur le service cloud hybride. Remarque Actuellement, seules les combinaisons suivantes sont prises en charge : lorsque Product est défini sur alb, ecs, clb4, clb7 ou nlb, Pattern doit être défini sur domain. Lorsque Product est défini sur waf, Pattern doit être défini sur multi_service.	domain
Detail	string	Oui	Les informations de paramètre spécifiques de l'objet protégé, qui correspondent à une chaîne convertie à partir d'un objet JSON construit avec une série de paramètres. Remarque Les paramètres varient en fonction du produit cloud (Product) et du mode de protection (Pattern) spécifiés. Pour plus d'informations, consultez Description du paramètre Detail pour les objets protégés. Important Lorsque Product est défini sur ecs, clb4, clb7 ou nlb, les noms de domaine connectés aux régions de Chine continentale doivent avoir terminé leur dépôt ICP.	{\"domain\": \"zhhclb4test096-05111.test.com\"}
XffStatus	integer	Non	Indique si le proxy XFF est activé pour l'objet protégé. Valeurs valides : 0 : désactivé (par défaut). 1 : activé.	0
CustomHeaders	array	Non	La liste des champs d'en-tête spécifiés. Remarque Lorsque XffStatus est défini sur 1, la première adresse IP du champ d'en-tête spécifié est utilisée comme adresse IP source du client afin d'empêcher l'usurpation XFF. Lorsque plusieurs en-têtes sont spécifiés, le système tente d'obtenir l'adresse IP source à partir de chaque en-tête dans l'ordre. Si le premier en-tête ne contient pas d'adresse IP, le système essaie le deuxième en-tête, et ainsi de suite. Si aucun en-tête spécifié ne contient d'adresse IP, la première adresse IP de l'en-tête X-Forwarded-For est utilisée. Lorsque XffStatus est défini sur 1, l'adresse IP est obtenue à partir du premier en-tête disponible.
	string	Non	Le champ d'en-tête spécifié.	x-forwarded-for
Description	string	Non	La description de l'objet protégé.	ResourceTest
InstanceId	string	Oui	L'identifiant de l'instance WAF. Remarque Vous pouvez appeler DescribeInstance pour interroger l'identifiant de l'instance WAF actuelle.	waf_v3prepaid_public_cn-4xl*******
OwnerUserId	string	Non	L'identifiant du compte auquel l'objet protégé appartient dans les scénarios multi-comptes. Par défaut, l'objet protégé appartient au compte administrateur WAF.	123221XXX
Tag	array<object>	Non	La liste des balises, qui contient jusqu'à 20 éléments.
	object	Non	La liste des balises de ressource, qui contient jusqu'à 20 éléments.
Key	string	Non	La clé de balise.	demoTagKey
Value	string	Non	La valeur de balise.	TagValue1
ResourceManagerResourceGroupId	string	Non	L'identifiant du groupe de ressources Alibaba Cloud.	rg-acfm***q
RegionId	string	Non	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

Description du paramètre Detail pour les objets protégés.

Configuration du site web ALB (Product défini sur alb, Pattern défini sur domain)

Ajoute un nom de domaine provenant d'une instance ALB déjà connectée à WAF en tant qu'objet protégé.

Description des paramètres

Nom	Type	Obligatoire	Exemple	Description
instanceId	String	Oui	alb-cj3w3********1x	L'identifiant de l'instance ALB déjà connectée à WAF.
domain	String	Oui	alb.test.com	Le nom de domaine à protéger par WAF.

Exemple

{
    "domain": "alb.test.com",
    "instanceId": "alb-cj3w3********1x"
}

Configuration du site web ECS (Product défini sur ecs, Pattern défini sur domain)

Ajoute un nom de domaine provenant d'une instance ECS déjà connectée à WAF en tant qu'objet protégé.

Description des paramètres

Nom	Type	Obligatoire	Exemple	Description
domain	String	Oui	ecs.test.com	Le nom de domaine à protéger par WAF. Le nom de domaine doit avoir terminé son dépôt ICP lorsqu'il est connecté à des régions de Chine continentale.

Exemple

{
    "domain": "ecs.test.com"
}

Configuration du site web CLB (Product défini sur clb4 ou clb7, Pattern défini sur domain)

Ajoute un nom de domaine provenant d'une instance CLB déjà connectée à WAF en tant qu'objet protégé.

Description des paramètres

Nom	Type	Obligatoire	Exemple	Description
domain	String	Oui	clb.test.com	Le nom de domaine à protéger par WAF. Le nom de domaine doit avoir terminé son dépôt ICP lorsqu'il est connecté à des régions de Chine continentale.

Exemple

{
    "domain": "clb.test.com"
}

Configuration du site web NLB (Product défini sur nlb, Pattern défini sur domain)

Ajoute un nom de domaine provenant d'une instance NLB déjà connectée à WAF en tant qu'objet protégé.

Description des paramètres

Nom	Type	Obligatoire	Exemple	Description
domain	String	Oui	nlb.test.com	Le nom de domaine à protéger par WAF. Le nom de domaine doit avoir terminé son dépôt ICP lorsqu'il est connecté à des régions de Chine continentale.

Exemple

{
    "domain": "nlb.test.com"
}

Accès au service cloud hybride WAF (Product défini sur waf, Pattern défini sur multi_service)

Crée un objet protégé pour un chemin de nom de domaine dans un cluster d'accès au service cloud hybride WAF.

Description des paramètres

Nom	Type	Obligatoire	Exemple	Description
domain	String	Oui	a.test.com	Le nom de domaine ou l'adresse IP à protéger par WAF.
url	String	Oui	/abc	Le chemin de l'URL.

Exemple

{
    "domain": "a.test.com",
    "url": "/abc"
}

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	1738C613-D054-5191-888B-DC0CF4C3A4A0
Resource	string	Le nom de l'objet protégé créé.	cdX.XXX-call.cn-alb

Exemples

JSON format

{
  "RequestId": "1738C613-D054-5191-888B-DC0CF4C3A4A0",
  "Resource": "cdX.XXX-call.cn-alb"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	Waf.Pullin.ResourceExsit	Access resource already exists, resource:%s.	La ressource connectée existe déjà. Ressource existante : %s.

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

Notes de version

Consultez Notes de version pour la liste complète.