ModifyDomain - Web Application Firewall - Centre de documentation Alibaba Cloud

Modifie un nom de domaine basé sur CNAME.

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

update

DefenseResource.

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

DefenseResource.

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

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****
Domain	string	Non	Le nom de domaine sur lequel opérer.	www.aliyundoc.com
DomainId	string	Non	L'identifiant du nom de domaine.	www.aliyundoc.com-waf
Listen	object	Oui	La configuration d'écoute.
HttpsPorts	array	Non	Les ports d'écoute pour HTTPS. Utilisez le format [port1,port2,...].
	integer	Non	Le port d'écoute pour HTTPS.	443
HttpPorts	array	Non	Les ports d'écoute pour HTTP. Utilisez le format [port1,port2,...].
	integer	Non	Le port d'écoute pour HTTP.	80
Http2Enabled	boolean	Non	Indique si HTTP/2 doit être activé. Ce paramètre est utilisé uniquement lorsque HttpsPorts n'est pas vide, ce qui indique que le nom de domaine utilise HTTPS. Valeurs valides :	true
CertId	string	Non	L'identifiant du certificat à ajouter.	123
SM2Enabled	boolean	Non	Indique si le certificat de chiffrement chinois (China SM) doit être activé.	true
SM2CertId	string	Non	L'identifiant du certificat China SM à ajouter. Ce paramètre est utilisé uniquement lorsque SM2Enable est défini sur true.	123-cn-hangzhou
SM2AccessOnly	boolean	Non	Indique si seul l'accès client doit être autorisé. Ce paramètre est utilisé uniquement lorsque SM2Enable est défini sur true.	true
TLSVersion	string	Non	La version TLS à ajouter. Ce paramètre est utilisé uniquement lorsque HttpsPorts n'est pas vide (ce qui indique que le nom de domaine utilise le protocole HTTPS). Valeurs valides : tlsv1 : Prend en charge TLS 1.0 et les versions ultérieures. Offre la meilleure compatibilité et le niveau de sécurité le plus faible. tlsv1.1 : Prend en charge TLS 1.1 et les versions ultérieures. Offre une bonne compatibilité et une bonne sécurité. tlsv1.2 : Prend en charge TLS 1.2 et les versions ultérieures. Offre une bonne compatibilité et le niveau de sécurité le plus élevé. tlsv1.3 : Prend en charge uniquement TLS 1.3. Offre le niveau de sécurité le plus élevé et la compatibilité la plus faible.	tlsv1
EnableTLSv3	boolean	Non	Indique si TLS 1.3 doit être pris en charge. Valeurs valides :	true
CipherSuite	integer	Non	Le type de suite cryptographique à ajouter. Ce paramètre est utilisé uniquement lorsque HttpsPorts n'est pas vide, ce qui indique que le nom de domaine utilise HTTPS. Valeurs valides :	2
CustomCiphers	array	Non	Les suites cryptographiques personnalisées spécifiques à ajouter. Ce paramètre est utilisé uniquement lorsque CipherSuite est défini sur 99.
	string	Non	La suite cryptographique personnalisée.	ECDHE-ECDSA-AES256-SHA384
FocusHttps	boolean	Non	Indique si la redirection HTTPS forcée doit être activée. Ce paramètre prend effet uniquement lorsque HttpsPorts n'est pas vide (ce qui indique que le nom de domaine utilise le protocole HTTPS) et que HttpPorts est vide (ce qui indique que le nom de domaine n'utilise pas le protocole HTTP). Valeurs valides : true : Active la redirection HTTPS forcée. false : N'active pas la redirection HTTPS forcée.	true
XffHeaderMode	integer	Non	La méthode utilisée par WAF pour obtenir l'adresse IP d'origine du client. Valeurs valides : 0 : (Par défaut) Le trafic client n'a été transféré par aucun autre proxy de couche 7 avant d'atteindre WAF. 1 : WAF lit la première valeur dans l'en-tête X-Forwarded-For (XFF) comme adresse IP du client. 2 : WAF lit la valeur d'un champ d'en-tête personnalisé que vous spécifiez comme adresse IP du client. 3 : WAF lit la valeur Client IP de l'en-tête Proxy Protocol comme adresse IP du client.	2
XffHeaders	array	Non	La liste des champs d'en-tête personnalisés utilisés pour obtenir l'adresse IP du client. Utilisez le format ["header1","header2",...].
	string	Non	Les champs d'en-tête personnalisés utilisés pour obtenir l'adresse IP du client.	Client-ip
IPv6Enabled	boolean	Non	Indique si IPv6 doit être activé. Valeurs valides :	true
ProtectionResource	string	Non	Le type de ressource de protection à utiliser. Valeurs valides :	share
ExclusiveIp	boolean	Non	Indique si la fonctionnalité d'adresse IP exclusive doit être activée. Ce paramètre n'est disponible que lorsque IPv6Enabled est défini sur false et que ProtectionResource est défini sur share. Valeurs valides : true : active la fonctionnalité d'adresse IP exclusive. false (par défaut) : n'active pas la fonctionnalité d'adresse IP exclusive.	true
HstsIncludeSubDomain	boolean	Non	Indique si HSTS inclut les sous-domaines. Valeurs valides :\n\n- true : Activé.\n\n- false : Non activé.	false
HstsPreload	boolean	Non	Indique si le préchargement HSTS doit être activé. Cette fonctionnalité est désactivée par défaut. Valeurs valides :	false
HstsMaxAge	integer	Non	Le délai d'expiration HSTS. Unité : secondes.	365000
Redirect	object	Oui	La configuration de transfert.
Backends	array	Non	Les adresses IP ou les noms de domaine des serveurs d'origine correspondant au nom de domaine. Vous ne pouvez définir qu'un seul type : adresses IP de serveur d'origine ou noms de domaine de serveur d'origine. Lorsque l'adresse de retour à l'origine est un nom de domaine, seul IPv4 est pris en charge. IPv6 n'est pas pris en charge.
	string	Non	L'adresse IP ou le nom de domaine du serveur d'origine.	1.1.XX.XX
Loadbalance	string	Oui	L'algorithme d'équilibrage de charge utilisé pour les requêtes de retour à l'origine. Valeurs valides : iphash : algorithme IP Hash. roundRobin : algorithme Round Robin. leastTime : algorithme Least Time. Cette valeur n'est disponible que lorsque ProtectionResource est défini sur gslb, ce qui indique que le type de ressource de protection utilise l'équilibrage de charge intelligent du cluster partagé.	iphash
FocusHttpBackend	boolean	Non	Indique si le retour à l'origine HTTP forcé doit être activé. Ce paramètre est utilisé uniquement lorsque HttpsPorts n'est pas vide, ce qui indique que le nom de domaine utilise HTTPS. Valeurs valides :	true
SniEnabled	boolean	Non	Indique si le SNI de retour à l'origine doit être activé. Ce paramètre est utilisé uniquement lorsque HttpsPorts n'est pas vide, ce qui indique que le nom de domaine utilise HTTPS. Valeurs valides :	true
SniHost	string	Non	La valeur du champ d'extension SNI personnalisé. Si vous ne définissez pas ce paramètre, la valeur du champ Host dans l'en-tête de requête est utilisée par défaut comme valeur du champ d'extension SNI. Dans la plupart des cas, il n'est pas nécessaire de personnaliser le SNI, sauf si votre entreprise a des exigences de configuration spécifiques et que vous souhaitez que le WAF utilise un SNI différent du Host de la requête réelle dans les requêtes de retour à l'origine (c'est-à-dire le SNI personnalisé défini ici). Remarque Ce paramètre est requis uniquement lorsque SniEnalbed est défini sur xxx (SNI de retour à l'origine personnalisé).	www.aliyundoc.com
RequestHeaders	array<object>	Non	Les champs et valeurs de balise de trafic du nom de domaine, utilisés pour baliser le trafic traité par WAF.
	object	Non	La valeur de ce paramètre est au format [*{"k":"key","v":"value"}]. key* spécifie le champ d'en-tête de requête personnalisé, et *value* spécifie la valeur définie pour le champ.
Key	string	Non	Le champ d'en-tête de requête personnalisé.	aaa
Value	string	Non	La valeur définie pour le champ d'en-tête de requête personnalisé.	bbb
ConnectTimeout	integer	Non	Le délai d'expiration de la connexion. Unité : secondes.	120
ReadTimeout	integer	Non	Le délai d'expiration de lecture. Unité : secondes.	200
WriteTimeout	integer	Non	Le délai d'expiration d'écriture. Unité : secondes.	200
CnameEnabled	boolean	Non	Indique si la reprise après sinistre sur cloud public doit être activée. Valeurs valides :	true
RoutingRules	string	Non	Les règles de transfert du cloud hybride. La valeur est une chaîne qui représente un tableau JSON. Chaque élément du tableau JSON est une structure qui contient les champs suivants : rs : type tableau \| La liste des adresses IP de retour à l'origine ou des CNAME de retour à l'origine. backupRs : type tableau \| La liste des adresses IP de retour à l'origine de secours ou des CNAME de retour à l'origine de secours. Ce champ est obligatoire. [] indique qu'aucune adresse de secours n'est configurée. location : type chaîne \| Le nom du nœud de protection. locationId : type long \| L'identifiant du nœud de protection.	[
Keepalive	boolean	Non	Indique si les connexions persistantes doivent être activées. Valeurs valides :	true
Retry	boolean	Non	Indique s'il faut réessayer lorsque le WAF ne parvient pas à transférer les requêtes vers le serveur d'origine. Valeurs valides : true (par défaut) : Réessayer. false : Ne pas réessayer.	true
KeepaliveRequests	integer	Non	Le nombre de requêtes qui réutilisent une connexion persistante. Valeurs valides : de 60 à 1000. Valeur par défaut : 1000.	1000
KeepaliveTimeout	integer	Non	Le délai d'expiration des connexions persistantes inactives. Valeurs valides : de 1 à 60. Valeur par défaut : 15. Unité : secondes.	15
XffProto	boolean	Non	Indique si X-Forward-For-Proto transmet le protocole WAF. Valeurs valides :	true
BackupBackends	array	Non	Les adresses IP ou les noms de domaine des serveurs d'origine secondaires correspondant au nom de domaine.
	string	Non	L'adresse IP ou le nom de domaine du serveur d'origine secondaire. Vous ne pouvez définir qu'un seul type : adresses IP de serveur d'origine ou noms de domaine de serveur d'origine. Lorsque l'adresse de retour à l'origine est un nom de domaine, seul IPv4 est pris en charge. IPv6 n'est pas pris en charge.	2.2.XX.XX
XClientIp	boolean	Non	Indique si WAF est autorisé à écraser X-Client-IP. Valeurs valides :	true
XTrueIp	boolean	Non	Indique si WAF est autorisé à écraser X-True-IP. Valeurs valides : true (par défaut) : WAF est autorisé à l'écraser. false : WAF n'est pas autorisé à l'écraser.	true
WebServerType	boolean	Non	Indique si WAF est autorisé à écraser Web-Server-Type. Valeurs valides :	true
WLProxyClientIp	boolean	Non	Indique si WAF est autorisé à écraser WL-Proxy-Client-IP. Valeurs valides :	true
MaxBodySize	integer	Non	La taille maximale du corps de la requête. Valeurs valides : de 2 à 10. Valeur par défaut : 2. Unité : Go.	2
Http2Origin	boolean	Non	Indique si la récupération à l'origine via HTTP/2 doit être activée. Valeurs valides : true : Active la récupération à l'origine via HTTP/2. false : N'active pas la récupération à l'origine via HTTP/2.	true
Http2OriginMaxConcurrency	integer	Non	Le nombre maximal de connexions simultanées pour le retour à l'origine HTTP/2. Valeurs valides : de 1 à 512. Valeur par défaut : 2.	128
ProxyProtocol	boolean	Non	Indique si la fonctionnalité de préservation de l'adresse IP source du client est activée. true : la fonctionnalité de préservation de l'adresse IP source du client est activée. Une fois cette fonctionnalité activée, les services back-end peuvent consulter l'adresse IP d'origine du client. false : la fonctionnalité de préservation de l'adresse IP source du client n'est pas activée.	false
BackendPorts	array<object>	Non	La configuration de port personnalisée.
	object	Non	La configuration de port personnalisée.
ListenPort	integer	Non	Le port d'écoute.	80
BackendPort	integer	Non	Le port de retour à l'origine.	80
Protocol	string	Non	Le protocole du port d'écoute. Valeurs valides : http : Le protocole du port d'écoute est HTTP. https : Le protocole du port d'écoute est HTTPS.	http
RegionId	string	Oui	La région où l'instance WAF est déployée. Valeurs valides : cn-hangzhou : la Chine continentale. ap-southeast-1 : hors de la Chine continentale.	cn-hangzhou
AccessType	string	Non	Le type d'accès de l'instance WAF. Valeurs valides :	share

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
RequestId	string	L'identifiant de la requête.	D7861F61-5B61-46CE-A47C-6B19160D****
DomainInfo	object	Les informations sur le nom de domaine ajouté.
Cname	string	Le CNAME attribué par WAF au nom de domaine.	xxxxxcvdaf.****.com
Domain	string	Le nom de domaine à modifier.	www.aliyundoc.com
DomainId	string	L'identifiant du nom de domaine.	www.aliyundoc.com-waf

Exemples

JSON format

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D****",
  "DomainInfo": {
    "Cname": "xxxxxcvdaf.****.com",
    "Domain": "www.aliyundoc.com",
    "DomainId": "www.aliyundoc.com-waf"
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	Waf.Pullin.BusinessViolation	The web services are suspected of violating regulations. If you have any questions, please submit a work order. Violating resource: %s.	Le service est soupçonné d'infractions. Si vous avez des questions, soumettez un ticket. Ressource en infraction : %s.
400	Waf.Control.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.	Le nom de domaine et l'identifiant du nom de domaine ne peuvent pas être vides tous les deux.
400	Waf.Control.DomainAndDomainIdNotMatch	domain and domainId do not match.	Le paramètre Domain ne correspond pas au paramètre DomainId.
400	Waf.Control.DomainIdIsIllegal	The input parameter, the domainId is illegal.	Le paramètre DomainId n'est pas valide.
400	Waf.Pullin.BackupBackendConflict	The backup backend configuration conflicts.	La configuration de retour à l'origine pour le lien secondaire présente un conflit.
400	Waf.Pullin.BackendPortIncompatible	The back-to-source port is incompatible with the listening port, listening protocol:%s, listening port:%s, back-to-source port:%s.	Le port de retour à l'origine est incompatible avec le port d'écoute. Protocole d'écoute : %s, port d'écoute : %s, port de retour à l'origine : %s.
400	Waf.Pullin.Http2OriginMustOnKeepaliveEnable	When the HTTP2 origin is turned on, the keepalive must be turned on.	Keep-alive doit être activé lorsque le retour à l'origine HTTP/2 est activé.
400	Waf.Pullin.Http2OriginEnabledFocusHttpBackendForbidden	When HTTP2 origin is enabled, HTTP origin cannot be enabled.	Le retour à l'origine HTTP ne peut pas être activé lorsque le retour à l'origine HTTP/2 est activé.
400	Waf.Pullin.BatchDnsScheduleCheckFailed	Batch dns scheduling is in progress, and access related operations are prohibited.	La planification DNS par lots est en cours. Les opérations de connexion associées sont interdites.
400	Waf.Pullin.InvalidMaxAgeWithPreload	HstsMaxAge the parameter is incorrect, when the HstsPreload is True, the HstsMaxAge must be greater than or equal to 31536000.	Le paramètre HstsMaxAge n'est pas valide. Lorsque HstsPreload est défini sur True, HstsMaxAge doit être supérieur ou égal à 31536000.
400	Waf.Pullin.InvalidIncludeSubDomainWithPreload	The parameter HstsIncludeSubDomain is invalid. When the parameter HstsPreload is true, the HstsIncludeSubDomain must be true.	Le paramètre HstsIncludeSubDomain n'est pas valide. Lorsque HstsPreload est défini sur true, HstsIncludeSubDomain doit également être défini sur true.
400	Waf.Pullin.InvalidCustomCiphers	Invalid custom cipher suite.	La suite de chiffrement personnalisée n'est pas valide.
400	Waf.Pullin.InvalidHttp2OriginWithProxyProtocol	http2Origin and proxyProtocol cannot be opened at the same time.	http2Origin et proxyProtocol ne peuvent pas être activés en même temps.

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

Notes de version

Consultez Notes de version pour la liste complète.