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

Observações de uso

Esta operação aceita consultas paginadas. Cada resposta inclui o status de proteção de cada nome de domínio, além do status e modo dos seguintes módulos:

Mecanismo de regras de proteção
Proteção contra flood HTTP
Política de proteção personalizada

Limites

Esta operação permite até 50 chamadas por segundo por conta. Exceder esse limite aciona o throttling, o que pode afetar o serviço.

Depuração

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDomainBasicConfigs	Operação a executar. Defina o valor como DescribeDomainBasicConfigs.
InstanceId	String	Sim	waf-cn-tl32ast****	ID da instância do WAF. Para obter o ID da instância, chame a operação DescribeInstanceInfo.
DomainKey	String	Não	aliyundoc	Palavra-chave para filtrar nomes de domínio. O WAF retorna as configurações de proteção dos domínios que contêm essa palavra-chave. Se omitido, todos os nomes de domínio serão retornados.
AccessType	String	Não	waf-cloud-dns	Modo de acesso para filtrar nomes de domínio. Valores válidos: waf-cloud-dns (modo de registro CNAME) e waf-cloud-native (modo de proxy transparente). Se omitido, todos os nomes de domínio serão retornados.
CloudNativeProductId	Integer	Não	0	Tipo de servidor de source, usado com o modo de proxy transparente. Valores válidos: 0 (instância do Elastic Compute Service (ECS)), 1 (instância do Classic Load Balancer (CLB)) e 2 (instância do Application Load Balancer (ALB)). Se omitido, todos os nomes de domínio serão retornados.
PageNumber	Integer	Não	1	Número da página. Valor padrão: 1.
PageSize	Integer	Não	10	Quantidade de entradas por página. Valor padrão: 10.
ResourceGroupId	String	Não	rg-acfm2pz25js****	ID do grupo de recursos no Resource Management. Se omitido, o sistema usa o grupo de recursos padrão.

Todas as solicitações devem incluir parâmetros comuns. Para mais informações, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
TotalCount	Integer	1	Número total de entradas retornadas.
RequestId	String	D7861F61-5B61-46CE-A47C-6B19160D5EB0	ID da solicitação.
DomainConfigs	Array of DomainConfig		Configurações de proteção dos nomes de domínio.
Status	Integer	1	Status das configurações de proteção. Valores válidos: 0 (inválido ou excluído), 1 (válido ou criado), 10 (criando), 11 (falha na criação) e 20 (excluindo).
Domain	String	www.aliyundoc.com	Nome de domínio.
Owner	String	WAF	Origem das configurações de proteção. Valor fixo: WAF.
CcMode	Integer	0	Modo do módulo de proteção contra flood HTTP. Valores válidos: 0 (modo de proteção) e 1 (modo de emergência).
CcStatus	Integer	1	Status do módulo de proteção contra flood HTTP. Valores válidos: 0 (desativado) e 1 (ativado).
AccessType	String	waf-cloud-dns	Modo de acesso do nome de domínio. Valores válidos: waf-cloud-dns (modo de registro CNAME) e waf-cloud-native (modo de proxy transparente).
Version	Long	0	Versão das configurações de proteção.
AclStatus	Integer	1	Status do módulo de política de proteção personalizada. Valores válidos: 0 (desativado) e 1 (ativado).
WafStatus	Integer	1	Status do mecanismo de regras de proteção. Valores válidos: 0 (desativado) e 1 (ativado).
WafMode	Integer	0	Modo do mecanismo de regras de proteção. Valores válidos: 0 (modo de bloqueio) e 1 (modo de alerta).

Exemplos

Exemplo de solicitação

http(s)://[Endpoint]/?Action=DescribeDomainBasicConfigs
&InstanceId=waf-cn-tl32ast****
&PageNumber=1
&PageSize=10
&<Common request parameters>

Exemplo de resposta de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDomainBasicConfigsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
    <DomainConfigs>
        <Status>1</Status>
        <Domain>www.aliyundoc.com</Domain>
        <Owner>WAF</Owner>
        <CcMode>0</CcMode>
        <CcStatus>1</CcStatus>
        <Version>0</Version>
        <AclStatus>1</AclStatus>
        <WafStatus>1</WafStatus>
        <WafMode>0</WafMode>
    </DomainConfigs>
</DescribeDomainBasicConfigsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount": 1,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "DomainConfigs": [{
    "Status": 1,
    "Domain": "www.aliyundoc.com",
    "Owner": "WAF",
    "CcMode": 0,
    "CcStatus": 1,
    "Version": 0,
    "AclStatus": 1,
    "WafStatus": 1,
    "WafMode": 0
  }]
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.