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

Consulta os nomes de domínio adicionados ao Web Application Firewall (WAF).

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

get

*DefenseResource

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

Nenhuma

yundun-waf:DescribeDomains

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância do WAF. Nota Chame DescribeInstance para visualizar o ID da instância atual do WAF.	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q
Domain	string	Não	O nome de domínio adicionado ao WAF.	www.aliyundoc.com
Backend	string	Não	O endereço IP do servidor de origem ou o nome de domínio de retorno à origem. Você pode especificar apenas uma dessas opções.	1.1.XX.XX
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10
DomainId	string	Não	O ID do nome de domínio.	www.aliyundoc.com-waf
RegionId	string	Não	A região onde a instância do WAF reside. Valores válidos: cn-hangzhou: a China continental. ap-southeast-1: fora da China continental.	cn-hangzhou
Tag	array<object>	Não	As tags do recurso. Há suporte para no máximo 20 tags.
	object	Não	As tags do recurso.
Key	string	Não	A chave da tag.	TagKey1
Value	string	Não	O valor da tag.	TagValue1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A lista de nomes de domínio adicionados.
RequestId	string	O ID da solicitação.	ABF68BB3-2C48-5FA4-9750-D5FE55700E36
TotalCount	integer	O número total de configurações de nome de domínio retornadas.	146
Domains	array<object>	A lista de nomes de domínio.
	array<object>	Os detalhes da conexão CNAME.
Domain	string	O nome de domínio que é adicionado ao WAF.	www.aliyundoc.com
Status	integer	O status do nome de domínio. Valores válidos: 1: O nome de domínio está em estado normal. 2: O nome de domínio está sendo criado. 3: O nome de domínio está sendo modificado. 4: O nome de domínio está sendo liberado. 5: O encaminhamento está desativado para o nome de domínio.	1
Cname	string	O nome canônico (CNAME) que é atribuído ao nome de domínio pelo WAF.	xxxxxcvdaf.****.com
ListenPorts	object	A configuração do listener.
Http	array	The list of listening ports for the HTTP protocol.
	integer	The listening port for the HTTP protocol.	80
Https	array	The list of listening ports for the HTTPS protocol.
	integer	The listening port for the HTTPS protocol.	443
Backeds	object	A configuração de retorno à origem.
Http	array<object>	The list of origin addresses for the HTTP protocol.
	object	The origin address for the HTTP protocol.
Backend	string	The origin address for the HTTP protocol.	1.1.XX.XX
Https	array<object>	The list of origin addresses for the HTTPS protocol.
	object	The origin address for the HTTPS protocol.
Backend	string	The origin address for the HTTPS protocol.	1.1.XX.XX
ResourceManagerResourceGroupId	string	O ID do grupo de recursos do Alibaba Cloud.	rg-acfmvtc5z52****
DomainId	string	O ID do nome de domínio.	www.aliyundoc.com-waf

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "ABF68BB3-2C48-5FA4-9750-D5FE55700E36",
  "TotalCount": 146,
  "Domains": [
    {
      "Domain": "www.aliyundoc.com",
      "Status": 1,
      "Cname": "xxxxxcvdaf.****.com",
      "ListenPorts": {
        "Http": [
          80
        ],
        "Https": [
          443
        ]
      },
      "Backeds": {
        "Http": [
          {
            "Backend": "1.1.XX.XX"
          }
        ],
        "Https": [
          {
            "Backend": "1.1.XX.XX"
          }
        ]
      },
      "ResourceManagerResourceGroupId": "rg-acfmvtc5z52****",
      "DomainId": "www.aliyundoc.com-waf"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.