DescribeDomainDetail - Web Application Firewall: Central de Documentação do Alibaba Cloud

Consulta os detalhes de uma configuração de site.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

yundun-waf:DescribeDomainDetail

get

DefenseResource.

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

DefenseResource.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância WAF. Nota Você pode chamar DescribeInstance para consultar o ID da instância WAF atual.	waf_cdnsdf3****
DomainId	string	Não	O ID do nome de domínio.	www.aliyundoc.com-waf
Domain	string	Não	O nome de domínio a ser consultado.	www.aliyundoc.com
RegionId	string	Não	A região onde a instância WAF está localizada. Valores válidos:	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes do CNAME.
RequestId	string	O ID da solicitação.	BAEF9CA9-66A0-533E-BD09-5D5D7AA8****
Domain	string	O nome de domínio.	www.aliyundoc.com
DomainId	string	O ID do nome de domínio.	www.aliyundoc.com-waf
Status	integer	O status do nome de domínio. Valores válidos:	1
Cname	string	O CNAME atribuído pelo WAF ao nome de domínio.	xxxxxcvdaf.****.com
Listen	object	A configuração do listener.
HttpPorts	array	A porta de escuta para o protocolo HTTP.
	integer	A porta de escuta para o protocolo HTTP.	80
HttpsPorts	array	A porta de escuta para o protocolo HTTPS.
	integer	A porta de escuta para o protocolo HTTPS.	443
Http2Enabled	boolean	Indica se o HTTP/2 está ativado. Valores válidos: true: O HTTP/2 está ativado. false: O HTTP/2 não está ativado.	true
CertId	string	O ID do certificado.	123
TLSVersion	string	A versão do TLS. Valores válidos: tlsv1: Suporta TLS 1.0 e versões posteriores. Oferece a maior compatibilidade e a menor segurança. tlsv1.1: Suporta TLS 1.1 e versões posteriores. Oferece boa compatibilidade e boa segurança. tlsv1.2: Suporta TLS 1.2 e versões posteriores. Oferece boa compatibilidade e a maior segurança. tlsv1.3: Suporta apenas TLS 1.3. Oferece a maior segurança e a menor compatibilidade.	tlsv1.2
EnableTLSv3	boolean	Indica se o TLS 1.3 é suportado. Valores válidos:	true
CipherSuite	integer	O tipo do conjunto de cifras. Valores válidos:	2
CustomCiphers	array	Os conjuntos de cifras personalizados.
	string	Os conjuntos de cifras personalizados.	ECDHE-ECDSA-AES256-SHA384
FocusHttps	boolean	Indica se o redirecionamento forçado para HTTPS está ativado. Valores válidos:	true
SM2Enabled	boolean	Indica se o certificado do Padrão de Criptografia da China (SM) está ativado. Valores válidos:	true
SM2CertId	string	O ID do certificado do Padrão de Criptografia da China (SM) a ser adicionado. Este parâmetro é usado apenas quando SM2Enable está definido como true.	123-cn-hangzhou
SM2AccessOnly	boolean	Indica se apenas o acesso de cliente SM é permitido. Este parâmetro é usado apenas quando SM2Enable está definido como true.	true
XffHeaderMode	integer	O método que o WAF utiliza para obter o endereço IP de origem do cliente. Valores válidos: 0: O tráfego de acesso do cliente não é encaminhado por outros proxies da Camada 7 antes de chegar ao WAF. 1: O WAF lê o primeiro valor no campo de cabeçalho X-Forwarded-For (XFF) da solicitação como o endereço IP do cliente. 2: O WAF lê o valor de um campo de cabeçalho personalizado especificado por você na solicitação como o endereço IP do cliente. 3: O WAF lê o IP do cliente a partir do cabeçalho do Proxy Protocol como o endereço IP do cliente.	2
XffHeaders	array	Os campos de cabeçalho personalizados usados para obter o endereço IP do cliente.
	string	Os campos de cabeçalho personalizados usados para obter o endereço IP do cliente.	Client-ip
IPv6Enabled	boolean	Indica se o IPv6 está ativado. Valores válidos: true: O IPv6 está ativado. false: O IPv6 não está ativado.	true
ProtectionResource	string	O tipo de recurso de proteção a ser usado. Valores válidos:	share
ExclusiveIp	boolean	Indica se um endereço IP exclusivo está ativado. Valores válidos: true: Um endereço IP exclusivo está ativado. false: Um endereço IP exclusivo não está ativado.	true
HstsIncludeSubDomain	boolean	Indica se o HSTS inclui subdomínios. Valores válidos: true: Ativado. false: Não ativado.
HstsPreload	boolean	Indica se o pré-carregamento HSTS está ativado. Este recurso está desativado por padrão. Valores válidos:	false
HstsMaxAge	integer	O tempo de expiração do HSTS. Unidade: segundos.	365000
Redirect	object	A configuração de encaminhamento.
Backends `deprecated`	array<object>	Os endereços de retorno à origem do nome de domínio.
	object	O endereço IP ou nome de domínio do servidor de origem.
Backend	string	O endereço IP ou nome de domínio do servidor de origem para o nome de domínio.	1.1.XX.XX
Loadbalance	string	O algoritmo de balanceamento de carga usado para solicitações de back-to-origin. Valores válidos: iphash: Algoritmo IP Hash. roundRobin: Algoritmo round-robin. leastTime: Algoritmo Least Time.	iphash
FocusHttpBackend	boolean	Indica se o back-to-origin HTTP forçado está ativado. Valores válidos: true: O back-to-origin HTTP forçado está ativado. false: O back-to-origin HTTP forçado não está ativado.	true
SniEnabled	boolean	Indica se o Server Name Indication (SNI) está ativado para solicitações de retorno à origem. Valores válidos: true: O SNI está ativado para solicitações de retorno à origem. false (padrão): O SNI não está ativado para solicitações de retorno à origem.	true
SniHost	string	O valor do campo de extensão SNI personalizado.	www.aliyundoc.com
RequestHeaders	array<object>	Os campos e valores de tags de tráfego do nome de domínio, usados para marcar o tráfego processado pelo WAF.
	object	Os campos e valores de tags de tráfego do nome de domínio, usados para marcar o tráfego processado pelo WAF.
Key	string	O campo de cabeçalho de solicitação personalizado.	aaa
Value	string	O valor do campo de cabeçalho de solicitação personalizado.	bbb
ConnectTimeout	integer	O período de tempo limite de conexão. Unidade: segundos.	120
WriteTimeout	integer	O período de tempo limite de gravação. Unidade: segundos.	200
ReadTimeout	integer	O período de tempo limite de leitura. Unidade: segundos.	200
Keepalive	boolean	Especifica se a conexão deve ser mantida ativa. Valores válidos: true (padrão): A conexão é mantida ativa. false: A conexão não é mantida ativa.	true
Retry	boolean	Especifica se deve ser feita uma nova tentativa quando o WAF falhar ao encaminhar solicitações para o servidor de origem. Valores válidos: true (padrão): Tentar novamente. false: Não tentar novamente.	true
KeepaliveRequests	integer	O número de solicitações que reutilizam uma conexão persistente. Valores válidos: 60 a 1000.	1000
KeepaliveTimeout	integer	O período de tempo limite ocioso para conexões persistentes. Valores válidos: 1 a 60. Valor padrão: 15. Unidade: segundos.	15
XffProto	boolean	Indica se X-Forward-For-Proto é usado para passar o protocolo utilizado pelo WAF. Valores válidos:	true
BackupBackends `deprecated`	array<object>	Os endereços de origem secundários do nome de domínio. Nota Este parâmetro está prestes a ser descontinuado. Use BackUpBackendList para obter as informações relacionadas.
	object	O endereço IP ou nome de domínio do servidor de origem.
Backend	string	O endereço IP ou nome de domínio do servidor de origem secundário para o nome de domínio.	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	Especifica se o WAF tem permissão para sobrescrever o X-Client-IP. Valores válidos: true (padrão): O WAF tem permissão para sobrescrever o cabeçalho. false: O WAF não tem permissão para sobrescrever o cabeçalho.	true
XTrueIp	boolean	Especifica se o WAF tem permissão para sobrescrever o cabeçalho X-True-IP. Valores válidos: true (padrão): O WAF tem permissão para sobrescrever o cabeçalho. false: O WAF não tem permissão para sobrescrever o cabeçalho.	true
WebServerType	boolean	Especifica se o WAF tem permissão para sobrescrever o cabeçalho Web-Server-Type. Valores válidos: true (padrão): O WAF tem permissão para sobrescrever o cabeçalho. false: O WAF não tem permissão para sobrescrever o cabeçalho.	true
WLProxyClientIp	boolean	Especifica se o WAF tem permissão para substituir o cabeçalho WL-Proxy-Client-IP. Valores válidos: true (padrão): O WAF tem permissão para substituir o cabeçalho. false: O WAF não tem permissão para substituir o cabeçalho.	true
MaxBodySize	integer	O tamanho máximo do corpo da solicitação. Valores válidos: 2 a 10. Valor padrão: 2. Unidade: GB.	2
Http2Origin	boolean	Indica se o retorno à origem via HTTP/2 está ativado.	true
Http2OriginMaxConcurrency	integer	O número máximo de conexões simultâneas para retorno à origem via HTTP/2.	128
ProxyProtocol	boolean	Indica se o recurso de preservação do endereço IP de origem do cliente está ativado. true: O recurso de preservação do endereço IP de origem do cliente está ativado. Após a ativação desse recurso, os serviços de back-end podem visualizar o endereço IP original do cliente. false: O recurso de preservação do endereço IP de origem do cliente não está ativado.	false
BackendList	array	A lista de endereços IP do servidor de origem ou nomes de domínio de back-to-origin para o nome de domínio.
	string	O endereço IP ou nome de domínio do servidor de origem para o nome de domínio.	1.1.XX.XX
BackUpBackendList	array	A lista de endereços IP do servidor de origem de backup ou nomes de domínio de back-to-origin para o nome de domínio.
	string	O endereço IP do servidor de origem de backup ou nome de domínio de back-to-origin para o nome de domínio.	2.2.XX.XX
BackendPorts	array<object>	A configuração de porta personalizada. Por padrão, a porta é a mesma que a porta do listener.
	object	A configuração de porta personalizada. Por padrão, a porta é a mesma que a porta do listener.
ListenPort	integer	A porta do listener.	80
BackendPort	integer	A porta de back-to-origin.	80
Protocol	string	O tipo de protocolo da porta do listener. Valores válidos:	http
ResourceManagerResourceGroupId	string	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q
CertDetail	object	Os detalhes do certificado SSL.
Name	string	O nome do certificado.	test-cert-name
Id	string	O ID do certificado SSL.	123-cn-hangzhou
StartTime	integer	O período de vigência do certificado. O valor está no formato de timestamp UNIX (UTC). Unidade: milissegundos.	1677772800000
EndTime	integer	A hora em que o certificado expira. O valor é um timestamp UNIX (UTC). Unidade: milissegundos.	1685590400000
CommonName	string	O nome comum (CN).	test.aliyundoc.com
Sans	array	Todos os nomes de domínio vinculados ao certificado.
	string	Todos os nomes de domínio vinculados ao certificado.	www.aliyundoc.com
SM2CertDetail	object	As informações do certificado SM2.
Name	string	O nome do certificado.	test-sm2-cert-name
Id	string	O ID do certificado SSL.	123-cn-hangzhou
StartTime	integer	O período de vigência do certificado. O valor está no formato de timestamp UNIX (UTC). Unidade: milissegundos.	1657551525000
EndTime	integer	A hora em que o certificado expira. O valor é um timestamp UNIX (UTC). Unidade: milissegundos.	1665590400000
CommonName	string	O nome comum (CN).	test.aliyundoc.com
Sans	array	Todos os nomes de domínio vinculados ao certificado.
	string	Todos os nomes de domínio vinculados ao certificado.	www.aliyundoc.com

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "BAEF9CA9-66A0-533E-BD09-5D5D7AA8****",
  "Domain": "www.aliyundoc.com",
  "DomainId": "www.aliyundoc.com-waf",
  "Status": 1,
  "Cname": "xxxxxcvdaf.****.com",
  "Listen": {
    "HttpPorts": [
      80
    ],
    "HttpsPorts": [
      443
    ],
    "Http2Enabled": true,
    "CertId": "123",
    "TLSVersion": "tlsv1.2",
    "EnableTLSv3": true,
    "CipherSuite": 2,
    "CustomCiphers": [
      "xxx"
    ],
    "FocusHttps": true,
    "SM2Enabled": true,
    "SM2CertId": "123-cn-hangzhou",
    "SM2AccessOnly": true,
    "XffHeaderMode": 2,
    "XffHeaders": [
      "Client-ip"
    ],
    "IPv6Enabled": true,
    "ProtectionResource": "share",
    "ExclusiveIp": true,
    "HstsIncludeSubDomain": false,
    "HstsPreload": false,
    "HstsMaxAge": 365000
  },
  "Redirect": {
    "Backends": [
      {
        "Backend": "1.1.XX.XX"
      }
    ],
    "Loadbalance": "iphash",
    "FocusHttpBackend": true,
    "SniEnabled": true,
    "SniHost": "www.aliyundoc.com",
    "RequestHeaders": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ],
    "ConnectTimeout": 120,
    "WriteTimeout": 200,
    "ReadTimeout": 200,
    "Keepalive": true,
    "Retry": true,
    "KeepaliveRequests": 1000,
    "KeepaliveTimeout": 15,
    "XffProto": true,
    "BackupBackends": [
      {
        "Backend": "[\n    \"1.1.XX.XX\",\n    \"2.2.XX.XX\"\n]\n"
      }
    ],
    "XClientIp": true,
    "XTrueIp": true,
    "WebServerType": true,
    "WLProxyClientIp": true,
    "MaxBodySize": 2,
    "Http2Origin": true,
    "Http2OriginMaxConcurrency": 128,
    "ProxyProtocol": false,
    "BackendList": [
      "1.1.XX.XX"
    ],
    "BackUpBackendList": [
      "2.2.XX.XX"
    ],
    "BackendPorts": [
      {
        "ListenPort": 80,
        "BackendPort": 80,
        "Protocol": "http"
      }
    ]
  },
  "ResourceManagerResourceGroupId": "rg-acfm***q",
  "CertDetail": {
    "Name": "test-cert-name",
    "Id": "123-cn-hangzhou",
    "StartTime": 1677772800000,
    "EndTime": 1685590400000,
    "CommonName": "test.aliyundoc.com",
    "Sans": [
      "www.aliyundoc.com"
    ]
  },
  "SM2CertDetail": {
    "Name": "test-sm2-cert-name",
    "Id": "123-cn-hangzhou",
    "StartTime": 1657551525000,
    "EndTime": 1665590400000,
    "CommonName": "test.aliyundoc.com",
    "Sans": [
      "www.aliyundoc.com"
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.	O nome de domínio e o ID do nome de domínio não podem estar ambos vazios.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.	O parâmetro Domain não corresponde ao parâmetro DomainId.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.	O parâmetro DomainId é inválido.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.