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

Consulta uma lista de alertas.

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

get

*All Resource

*

acs:ResourceGroupId

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância do Web Application Firewall (WAF). Nota Chame DescribeInstance para consultar o ID da instância do WAF.	waf_v2_public_cn-pe33e****
RegionId	string	Não	A região em que a instância do WAF está localizada. Valores válidos: cn-hangzhou: a China continental. ap-southeast-1: fora da China continental.	cn-hangzhou
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-aek2ipnu***

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	8D8EBFB7-E1EB-5236-952A-092EDC72***
Alarms	array<object>	Os alertas.
	object	Os detalhes do alerta.
Status	integer	O status atual do alerta. Valores válidos: 1: O limite de consultas por segundo (QPS) foi excedido. 2: A instância do WAF entra na sandbox. 3: A instância do WAF é removida da sandbox. 4: O QPS não excede mais o limite.	1
Type	string	O tipo do alerta. Valor válido: qps: um alerta de QPS.	qps
MaxQps	integer	O pico de QPS durante o período do alerta.	12000
EndTime	integer	O horário de término do alerta. Este é um timestamp UNIX. Unidade: milissegundos.	1605600798
Cause	string	A causa do alerta. Valores válidos: fivefold: O QPS excede o limite das especificações atuais da instância do WAF. 4count: O QPS real excedeu cumulativamente o limite das especificações atuais da instância do WAF. exceed10w: O pico de QPS excede 100.000. costProtection: A proteção de faturamento é acionada.	4count
StartTime	integer	O horário de início do alerta. Este é um timestamp UNIX. Unidade: milissegundos.	1605600767
Spec	integer	O limite de QPS das especificações atuais da instância do WAF.	10000

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "8D8EBFB7-E1EB-5236-952A-092EDC72***",
  "Alarms": [
    {
      "Status": 1,
      "Type": "qps",
      "MaxQps": 12000,
      "EndTime": 1605600798,
      "Cause": "4count",
      "StartTime": 1605600767,
      "Spec": 10000
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.