CreateLogDeliveryConfig - Web Application Firewall - Centre de documentation Alibaba Cloud

Description de l'opération

Avant d'appeler cette opération, assurez-vous que des nœuds d'extension de cloud hybride ont été achetés pour l'instance WAF. Vous pouvez appeler l'opération DescribeInstance pour consulter les détails de l'instance. Si la valeur du paramètre de réponse Details.HybridCloudNodeExtend est supérieure à 0, des nœuds d'extension de cloud hybride ont été achetés. Dans le cas contraire, connectez-vous à la console WAF et mettez à niveau l'instance pour acheter des nœuds d'extension de cloud hybride.

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

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 l'opération DescribeInstance pour obtenir l'identifiant de l'instance WAF actuelle.	waf_elasticity-cn-0xldbqt****
DeliveryName	string	Oui	Le nom de la configuration de livraison des logs.	test1
DeliveryType	string	Oui	Le type de la configuration de livraison des logs. Valeurs valides : syslog : livre les logs à un service syslog. kafka : livre les logs à un service Kafka.	syslog
DeliveryDetail	string	Oui	Le contenu de la configuration de livraison des logs. La valeur est une chaîne JSON construite à partir d'une série de paramètres. Remarque Les paramètres varient en fonction du type de livraison (DeliveryType) spécifié. Pour plus d'informations, consultez la section Description des paramètres du contenu de la configuration de livraison.	{ "rfcVersion": "rfc3164", "protocol": "tcp", "servers": [ { "address": "1.1.1.1", "port": 20 } ] }
RegionId	string	Non	La région où réside l'instance WAF. Valeurs valides : cn-hangzhou : Chine continentale. ap-southeast-1 : en dehors de la Chine continentale.	cn-hangzhou
ResourceManagerResourceGroupId	string	Non	L'identifiant du groupe de ressources Alibaba Cloud.	rg-acfm***q

Description des paramètres du contenu de la configuration de livraison.

Livraison des logs à un service syslog (syslog)

Description des paramètres

Nom	Type	Obligatoire	Exemple	Description
servers	Array	Oui	[{"address":"11.11.XX.XX","port":8000}]	La configuration de l'adresse distante du service syslog. Lorsque le type de livraison est syslog, une seule adresse est prise en charge. Champs : - address : le nom de domaine ou l'adresse IP du serveur. IPv4 et IPv6 sont pris en charge. Obligatoire. - port : le port du serveur. Obligatoire.
rfcVersion	String	Non	rfc3164	La version RFC de syslog. Valeurs valides : - rfc3164 (par défaut) : RFC 3164. - rfc5424 : RFC 5424.
protocol	String	Oui	tcp	Le type de protocole de syslog. Valeurs valides : - tcp : connexion TCP. - udp : connexion UDP.

Exemple

{
	"InstanceId": "waf_v2_public_cn-n*******",
	"DeliveryName": "test1",
	"DeliveryType": "syslog",
	"DeliveryDetail": "{\"rfcVersion\":\"rfc3164\",\"protocol\":\"tcp\",\"servers\":[{\"address\":\"11.11.XX.XX\",\"port\":8000}]}"
}

Livraison des logs à un service Kafka (kafka)

Description des paramètres

Nom	Type	Obligatoire	Exemple	Description
servers	Array	Oui	[{"address":"a.com","port":8000}]	La configuration de l'adresse distante du service Kafka. Lorsque le type de livraison est kafka, jusqu'à trois adresses sont prises en charge. Champs : - address : le nom de domaine ou l'adresse IP du serveur. IPv4 et IPv6 sont pris en charge. Obligatoire. - port : le port du serveur. Obligatoire.
kafkaTopic	String	Oui	test	L'identifiant ou le nom du sujet Kafka.
protocol	String	Oui	PLAINTEXT	Le protocole de sécurité de Kafka. Valeurs valides : - PLAINTEXT (par défaut) : protocole PLAINTEXT. - SASL_PLAINTEXT : protocole SASL_PLAINTEXT. - SASL_SSL : protocole SASL_SSL.
saslUserName	String	Non	user123	Le nom d'utilisateur pour l'authentification SASL de Kafka. Obligatoire lorsque le protocole de sécurité (protocol) est défini sur SASL_PLAINTEXT ou SASL_SSL.
saslPassword	String	Non	user***	Le mot de passe pour l'authentification SASL de Kafka. Obligatoire lorsque le protocole de sécurité (protocol) est défini sur SASL_PLAINTEXT ou SASL_SSL.
pemCert	String	Non	Cert	Le certificat personnalisé pour Kafka. Le format PEM est pris en charge.
compressionCodec	String	Non	none	Le type de compression de Kafka. Valeurs valides : - none (par défaut) : aucune compression. - gzip : compression gzip. - zstd : compression zstd. - lz4 : compression lz4. - snappy : compression snappy.

Exemple

{
	"InstanceId": "waf_v2_public_cn-n*********",
	"DeliveryName": "test2",
	"DeliveryType": "kafka",
	"DeliveryDetail": "{\"kafkaTopic\":\"topictest1\",\"protocol\":\"SASL_PLAINTEXT\",\"servers\":[{\"address\":\"a.com\",\"port\":1000},{\"address\":\"ba.com\",\"port\":1000},{\"address\":\"c.com\",\"port\":1000}],\"saslUserName\":\"user123\",\"saslPassword\":\"user****\"}"
}

Éléments de réponse

Élément	Type	Description	Exemple
	object
DeliveryName	string	Le nom de la configuration de livraison des logs.	test1
RequestId	string	L'identifiant de la requête.	26E46541-7AAB-5565-801D-F14DBDC5****

Exemples

JSON format

{
  "DeliveryName": "test1",
  "RequestId": "26E46541-7AAB-5565-801D-F14DBDC5****"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.