Use a operação DescribeDomain para consultar as configurações de um nome de domínio protegido pelo WAF - Web Application Firewall: Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer, que também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDomain	Operação a executar. Defina o valor como DescribeDomain.
Domain	String	Sim	www.example.com	Nome de domínio a consultar. Para obter os nomes de domínio adicionados ao WAF, chame a operação DescribeDomainNames.
InstanceId	String	Sim	waf-cn-7pp26f1****	ID da instância do WAF. Para obter o ID da instância, chame a operação DescribeInstanceInfo.

Todas as solicitações de API da Alibaba Cloud devem incluir parâmetros de solicitação comuns. Para mais informações, consulte Parâmetros de solicitação comuns.

Elementos de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	D827FCFE-90A7-4330-9326-D33C8B4C7726	ID da solicitação.
Domain	Struct		Configuração do nome de domínio.

Domain

Parâmetro	Tipo	Exemplo	Descrição
AccessHeaderMode	Integer	1	Método para obter o endereço IP real do cliente. Valores válidos: 0: o WAF lê o primeiro valor do cabeçalho X-Forwarded-For (XFF). 1: o WAF lê o valor de um campo de cabeçalho personalizado. Retornado apenas quando IsAccessProduct é 1.
AccessHeaders	List	["X-Client-IP"]	Campo de cabeçalho personalizado usado para obter o endereço IP real do cliente. Retornado apenas quando AccessHeaderMode é 1.
AccessType	String	waf-cloud-dns	Modo de adição do nome de domínio ao WAF. Valores válidos: waf-cloud-dns: modo de registro CNAME. waf-cloud-native: modo de proxy transparente.
ClusterType	Integer	0	Tipo de cluster de proteção do WAF. Valores válidos: 0: cluster compartilhado. 1: cluster exclusivo. Retornado apenas quando AccessType é waf-cloud-dns.
Cname	String	kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com	CNAME atribuído pelo WAF ao nome de domínio. Retornado apenas quando AccessType é waf-cloud-dns.
ConnectionTime	Integer	5	Tempo limite de conexão dos clusters do WAF. Unidade: segundos. Retornado apenas quando AccessType é waf-cloud-dns.
Http2Port	List	[443,8443]	Portas HTTP/2. Retornado apenas quando AccessType é waf-cloud-dns e HttpsPort está especificado.
HttpPort	List	[80]	Portas HTTP. Retornado apenas quando AccessType é waf-cloud-dns.
HttpToUserIp	Integer	0	Indica se o redirecionamento de HTTPS para HTTP nas solicitações back-to-origin está ativado. Valores válidos: 0: desativado. 1: ativado. Retornado apenas quando AccessType é waf-cloud-dns e HttpsPort está especificado.
HttpsPort	List	[443,8443]	Portas HTTPS. Retornado apenas quando AccessType é waf-cloud-dns.
HttpsRedirect	Integer	0	Indica se o redirecionamento de HTTP para HTTPS está ativado. Valores válidos: 0: desativado. 1: ativado. Retornado apenas quando AccessType é waf-cloud-dns e HttpsPort está especificado.
IpFollowStatus	Integer	1	Indica se o WAF encaminha solicitações ao servidor de origem usando o mesmo tipo de endereço IP da solicitação original. Valores válidos: 0: desativado. 1: ativado. Retornado apenas quando AccessType é waf-cloud-dns.
IsAccessProduct	Integer	1	Indica se há um proxy de camada 7 configurado antes do WAF. Os proxies de camada 7 incluem Anti-DDoS Pro, Anti-DDoS Premium e Alibaba Cloud CDN. Valores válidos: 0: nenhum proxy de camada 7 configurado. 1: proxy de camada 7 configurado.
Keepalive	Boolean	true	Indica se as conexões persistentes estão ativadas. Valores válidos: true (padrão). false.
KeepaliveRequests	Integer	1000	Número máximo de solicitações por conexão persistente. Valores válidos: 60 a 1000.
KeepaliveTimeout	Integer	15	Tempo limite de ociosidade para conexões persistentes. Unidade: segundos. Valores válidos: 1 a 60. Valor padrão: 15.
LoadBalancing	Integer	2	Algoritmo de balanceamento de carga para encaminhamento de solicitações ao servidor de origem. Valores válidos: 0: hash de IP. 1: round-robin. 2: menor tempo. Retornado apenas quando AccessType é waf-cloud-dns.
ReadTime	Integer	120	Tempo limite de conexão de leitura dos clusters do WAF. Unidade: segundos. Retornado apenas quando AccessType é waf-cloud-dns.
ResourceGroupId	String	rg-acfm2mkrunv****	ID do grupo de recursos ao qual a instância do WAF pertence.
Retry	Boolean	true	Indica se o WAF tenta reencaminhar solicitações ao servidor de origem após falha no encaminhamento. Valores válidos: true (padrão). false.
SniHost	String	waf.example.com	Valor do campo personalizado Server Name Indication (SNI). Se vazio, usa-se o valor do cabeçalho Host. Retornado apenas quando SniStatus é 1.
SniStatus	Integer	1	Indica se o SNI de origem está ativado. O SNI de origem é o nome de domínio usado para estabelecer uma conexão HTTPS durante o handshake TLS quando o WAF encaminha solicitações ao servidor de origem. Valores válidos: 0: desativado. 1: ativado. Retornado apenas quando AccessType é waf-cloud-dns e HttpsPort está especificado.
SourceIps	List	["39.XX.XX.197"]	Endereços IP do servidor de origem. Retornado apenas quando AccessType é waf-cloud-dns.
Version	Long	40	Número da versão da configuração do nome de domínio.
WriteTime	Integer	120	Tempo limite de conexão de gravação dos clusters do WAF. Unidade: segundos. Retornado apenas quando AccessType é waf-cloud-dns.

CloudNativeInstances (retornado apenas quando AccessType é waf-cloud-native)

Parâmetro	Tipo	Exemplo	Descrição
CloudNativeProductName	String	ALB	Tipo de instância de serviço em nuvem. Valores válidos: SLB: instância do Classic Load Balancer (CLB), anteriormente conhecido como Server Load Balancer (SLB). ECS: instância do Elastic Compute Service (ECS). ALB: instância do Application Load Balancer (ALB).
IPAddressList	String	["39.XX.XX.197"]	Endereços IP públicos da instância de serviço em nuvem.
InstanceId	String	alb-s65nua68wdedsp****	ID da instância de serviço em nuvem.

ProtocolPortConfigs (dentro de CloudNativeInstances)

Parâmetro	Tipo	Exemplo	Descrição
Ports	String	[80]	Portas.
Protocol	String	http	Protocolo. Valores válidos: http. https.
RedirectionTypeName	String	ALB	Tipo de porta de redirecionamento de tráfego. Valores válidos: SLB-L4: portas de escuta de camada 4 da instância CLB. SLB-L7: portas de escuta de camada 7 da instância CLB. ECS: portas de escuta de instâncias ECS. ALB: portas de escuta HTTP e HTTPS de instâncias ALB.

LogHeaders (retornado apenas quando a marcação de tráfego está ativada para o nome de domínio)

Parâmetro	Tipo	Exemplo	Descrição
k	String	ALIWAF-TAG	Nome do campo de cabeçalho personalizado.
v	String	Yes	Valor do campo de cabeçalho personalizado.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

Formato 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>

Formato 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
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.