Use the DescribeDomain operation to query the configurations of a domain name protected by WAF - Web Application Firewall

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeDomain	Opération à effectuer. Définissez la valeur sur DescribeDomain.
Domain	String	Oui	www.example.com	Nom de domaine à interroger. Pour obtenir les noms de domaine ajoutés à WAF, appelez l'opération DescribeDomainNames.
InstanceId	String	Oui	waf-cn-7pp26f1****	ID de l'instance WAF. Pour obtenir l'ID de l'instance, appelez l'opération DescribeInstanceInfo.

Toutes les requêtes API Alibaba Cloud doivent inclure des paramètres de requête communs. Pour plus d'informations, consultez la rubrique Paramètres de requête communs.

Éléments de réponse

Paramètre	Type	Exemple	Description
RequestId	String	D827FCFE-90A7-4330-9326-D33C8B4C7726	ID de la requête.
Domain	Struct		Configuration du nom de domaine.

Domain

Paramètre	Type	Exemple	Description
AccessHeaderMode	Integer	1	Méthode utilisée pour obtenir l'adresse IP réelle du client. Valeurs possibles : 0 : WAF lit la première valeur de l'en-tête X-Forwarded-For (XFF). 1 : WAF lit la valeur d'un champ d'en-tête personnalisé. Renvoyé uniquement lorsque IsAccessProduct est défini sur 1.
AccessHeaders	List	["X-Client-IP"]	Champ d'en-tête personnalisé utilisé pour obtenir l'adresse IP réelle du client. Renvoyé uniquement lorsque AccessHeaderMode est défini sur 1.
AccessType	String	waf-cloud-dns	Mode utilisé pour ajouter le nom de domaine à WAF. Valeurs possibles : waf-cloud-dns : mode d'enregistrement CNAME. waf-cloud-native : mode proxy transparent.
ClusterType	Integer	0	Type de cluster de protection WAF. Valeurs possibles : 0 : cluster partagé. 1 : cluster exclusif. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns.
Cname	String	kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com	CNAME attribué par WAF au nom de domaine. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns.
ConnectionTime	Integer	5	Délai d'expiration de la connexion pour les clusters WAF. Unité : secondes. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns.
Http2Port	List	[443,8443]	Ports HTTP/2. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns et que HttpsPort est spécifié.
HttpPort	List	[80]	Ports HTTP. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns.
HttpToUserIp	Integer	0	Indique si la redirection HTTPS vers HTTP pour les requêtes de retour à l'origine est activée. Valeurs possibles : 0 : désactivé. 1 : activé. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns et que HttpsPort est spécifié.
HttpsPort	List	[443,8443]	Ports HTTPS. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns.
HttpsRedirect	Integer	0	Indique si la redirection HTTP vers HTTPS est activée. Valeurs possibles : 0 : désactivé. 1 : activé. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns et que HttpsPort est spécifié.
IpFollowStatus	Integer	1	Indique si WAF transfère les requêtes au serveur d'origine en utilisant le même type d'adresse IP que la requête. Valeurs possibles : 0 : désactivé. 1 : activé. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns.
IsAccessProduct	Integer	1	Indique si un proxy de couche 7 est configuré devant WAF. Les proxies de couche 7 incluent Anti-DDoS Pro, Anti-DDoS Premium et Alibaba Cloud CDN. Valeurs possibles : 0 : aucun proxy de couche 7 n'est configuré. 1 : un proxy de couche 7 est configuré.
Keepalive	Boolean	true	Indique si les connexions persistantes sont activées. Valeurs possibles : true (par défaut). false.
KeepaliveRequests	Integer	1000	Nombre maximal de requêtes par connexion persistante. Valeurs possibles : 60 à 1000.
KeepaliveTimeout	Integer	15	Délai d'inactivité pour les connexions persistantes. Unité : secondes. Valeurs possibles : 1 à 60. Valeur par défaut : 15.
LoadBalancing	Integer	2	Algorithme d'équilibrage de charge pour le transfert des requêtes au serveur d'origine. Valeurs possibles : 0 : hachage IP. 1 : tourniquet (round-robin). 2 : temps le plus court. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns.
ReadTime	Integer	120	Délai d'expiration de la connexion en lecture pour les clusters WAF. Unité : secondes. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns.
ResourceGroupId	String	rg-acfm2mkrunv****	ID du groupe de ressources auquel appartient l'instance WAF.
Retry	Boolean	true	Indique si WAF réessaie de transférer les requêtes au serveur d'origine après un échec de transfert. Valeurs possibles : true (par défaut). false.
SniHost	String	waf.example.com	Valeur du champ Server Name Indication (SNI) personnalisé. Si vide, la valeur de l'en-tête Host est utilisée. Renvoyé uniquement lorsque SniStatus est défini sur 1.
SniStatus	Integer	1	Indique si le SNI d'origine est activé. Le SNI d'origine est le nom de domaine utilisé pour établir une connexion HTTPS lors de la négociation TLS lorsque WAF transfère les requêtes au serveur d'origine. Valeurs possibles : 0 : désactivé. 1 : activé. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns et que HttpsPort est spécifié.
SourceIps	List	["39.XX.XX.197"]	Adresses IP du serveur d'origine. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns.
Version	Long	40	Numéro de version de la configuration du nom de domaine.
WriteTime	Integer	120	Délai d'expiration de la connexion en écriture pour les clusters WAF. Unité : secondes. Renvoyé uniquement lorsque AccessType est défini sur waf-cloud-dns.

CloudNativeInstances (renvoyé uniquement lorsque AccessType est défini sur waf-cloud-native)

Paramètre	Type	Exemple	Description
CloudNativeProductName	String	ALB	Type d'instance de service cloud. Valeurs possibles : SLB : instance Classic Load Balancer (CLB), anciennement connue sous le nom de Server Load Balancer (SLB). ECS : instance Elastic Compute Service (ECS). ALB : instance Application Load Balancer (ALB).
IPAddressList	String	["39.XX.XX.197"]	Adresses IP publiques de l'instance de service cloud.
InstanceId	String	alb-s65nua68wdedsp****	ID de l'instance de service cloud.

ProtocolPortConfigs (au sein de CloudNativeInstances)

Paramètre	Type	Exemple	Description
Ports	String	[80]	Ports.
Protocol	String	http	Protocole. Valeurs possibles : http. https.
RedirectionTypeName	String	ALB	Type de port de redirection du trafic. Valeurs possibles : SLB-L4 : ports d'écoute de couche 4 de l'instance CLB. SLB-L7 : ports d'écoute de couche 7 de l'instance CLB. ECS : ports d'écoute des instances ECS. ALB : ports d'écoute HTTP et HTTPS des instances ALB.

LogHeaders (renvoyé uniquement lorsque le marquage du trafic est activé pour le nom de domaine)

Paramètre	Type	Exemple	Description
k	String	ALIWAF-TAG	Nom du champ d'en-tête personnalisé.
v	String	Yes	Valeur du champ d'en-tête personnalisé.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=DescribeDomain
&Domain=www.example.com
&InstanceId=waf-cn-7pp26f1****
&<Common request parameters>

Exemple de réponse réussie

Format XML

<DescribeDomainResponse>
      <RequestId>D827FCFE-90A7-4330-9326-D33C8B4C7726</RequestId>
      <Domain>
            <HttpToUserIp>0</HttpToUserIp>
            <HttpPort>80</HttpPort>
            <IsAccessProduct>1</IsAccessProduct>
            <AccessHeaderMode>1</AccessHeaderMode>
            <ResourceGroupId>rg-acfm2mkrunv****</ResourceGroupId>
            <AccessHeaders>X-Client-IP</AccessHeaders>
            <ReadTime>120</ReadTime>
            <SourceIps>39.XX.XX.197</SourceIps>
            <IpFollowStatus>1</IpFollowStatus>
            <ClusterType>0</ClusterType>
            <LoadBalancing>2</LoadBalancing>
            <Cname>kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com</Cname>
            <LogHeaders>
                  <v>Yes</v>
                  <k>ALIWAF-TAG</k>
            </LogHeaders>
            <WriteTime>120</WriteTime>
            <Http2Port>443</Http2Port>
            <Http2Port>8443</Http2Port>
            <Version>40</Version>
            <HttpsRedirect>0</HttpsRedirect>
            <ConnectionTime>5</ConnectionTime>
            <AccessType>waf-cloud-dns</AccessType>
            <HttpsPort>443</HttpsPort>
            <HttpsPort>8443</HttpsPort>
            <Keepalive>true</Keepalive>
            <KeepaliveTimeout>15</KeepaliveTimeout>
            <Retry>true</Retry>
            <KeepaliveRequests>1000</KeepaliveRequests>
      </Domain>
</DescribeDomainResponse>

Format JSON

{
  "RequestId": "D827FCFE-90A7-4330-9326-D33C8B4C7726",
  "Domain": {
    "HttpToUserIp": 0,
    "HttpPort": [
      80
    ],
    "IsAccessProduct": 1,
    "AccessHeaderMode": 1,
    "ResourceGroupId": "rg-acfm2mkrunv****",
    "AccessHeaders": [
      "X-Client-IP"
    ],
    "ReadTime": 120,
    "SourceIps": [
      "39.XX.XX.197"
    ],
    "IpFollowStatus": 1,
    "ClusterType": 0,
    "LoadBalancing": 2,
    "Cname": "kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com",
    "LogHeaders": [
      {
        "v": "Yes",
        "k": "ALIWAF-TAG"
      }
    ],
    "WriteTime": 120,
    "Http2Port": [
      443,
      8443
    ],
    "Version": 40,
    "HttpsRedirect": 0,
    "ConnectionTime": 5,
    "AccessType": "waf-cloud-dns",
    "HttpsPort": [
      443,
      8443
    ],
    "Keepalive": true,
    "KeepaliveTimeout": 15,
    "SniStatus": 0,
    "Retry": true,
    "KeepaliveRequests": 1000
  }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez la rubrique Codes d'erreur de service.