DescribeEventRuleList - Cloud Monitor: Central de Documentação do Alibaba Cloud

Consulta as regras de alerta acionadas por eventos.

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

cms:DescribeEventRuleList

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NamePrefix	string	Não	O prefixo da regra de alerta acionada por eventos.	test
PageNumber	string	Não	O número da página. Valor mínimo: 1. Valor padrão: 1.	1
PageSize	string	Não	O número de entradas a serem retornadas em cada página. Valor mínimo: 1. Valor padrão: 10.	10
GroupId	string	Não	O ID do grupo de aplicativos.	7378****
IsEnable	boolean	Não	Especifica se a regra de alerta acionada por eventos deve ser ativada. Valores válidos: true: ativada. Este é o valor padrão. false: desativada.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A lista de regras de alerta acionadas por eventos.
Code	string	O código de status. Um valor 200 indica sucesso.	200
Message	string	A mensagem de erro.	User not authorized to operate on the specified resource.
RequestId	string	O ID da solicitação.	D0E6D82B-16B5-422A-8136-EE5BDC01E415
Total	integer	O número total de entradas.	21
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: A operação foi bem-sucedida. false: A operação falhou.	true
EventRules	object
EventRule	array<object>	A regra de alerta acionada por eventos.
	array<object>	A regra de alerta acionada por eventos.
EventType	string	O tipo do alerta acionado por eventos. Valores válidos: SYSTEM: evento do sistema. CUSTOM: evento personalizado.	SYSTEM
Description	string	A descrição da regra de alerta acionada por eventos.	Default group event rule.
GroupId	string	O ID do grupo de aplicativos.	7378****
Name	string	O nome da regra de alerta acionada por eventos.	test_DefaultEventRule_7378****
State	string	O estado da regra de alerta acionada por eventos. Valores válidos: ENABLED: ativada. DISABLED: desativada.	ENABLED
EventPattern	object
EventPattern	array<object>	O padrão de evento da regra de alerta acionada por eventos.
	array<object>	O padrão de evento da regra de alerta acionada por eventos.
Product	string	A abreviação do nome do serviço Alibaba Cloud.	CloudMonitor
LevelList	object
LevelList	array	A lista de níveis de evento.
	string	O nível do evento. Valores válidos: CRITICAL: crítico. WARN: aviso. INFO: informação.	CRITICAL
EventTypeList	object
EventTypeList	array	A lista de tipos de evento para a regra de alerta acionada por eventos.
	string	O tipo de evento da regra de alerta acionada por eventos. Um valor de * indica que o tipo de regra de alerta não é limitado.	*
NameList	object
NameList	array	A lista de nomes de eventos.
	string	A lista de nomes de eventos.	["Agent_Status_Stopped"]
CustomFilters	string	As condições de filtro personalizadas.	ECS123
KeywordFilter	object	O filtro de palavras-chave.
Keywords	object
Keywords	array	A lista de palavras-chave para correspondência de eventos.
	string	A palavra-chave.	VMException
Relation	string	A relação lógica entre várias palavras-chave. Valores válidos: OR: A relação lógica entre várias palavras-chave é OR. NOT: As palavras-chave não estão incluídas. Isso indica que todos os eventos que não contêm as palavras-chave na lista são correspondidos.	OR
SQLFilter	string	Filtra logs com base em instruções SQL. Se as condições forem atendidas, um alerta será acionado.	ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222
SilenceTime	integer	O período de silenciamento.	86400

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "D0E6D82B-16B5-422A-8136-EE5BDC01E415",
  "Total": 21,
  "Success": true,
  "EventRules": {
    "EventRule": [
      {
        "EventType": "SYSTEM",
        "Description": "Default group event rule.",
        "GroupId": "7378****",
        "Name": "test_DefaultEventRule_7378****",
        "State": "ENABLED",
        "EventPattern": {
          "EventPattern": [
            {
              "Product": "CloudMonitor",
              "LevelList": {
                "LevelList": [
                  "CRITICAL"
                ]
              },
              "EventTypeList": {
                "EventTypeList": [
                  "*"
                ]
              },
              "NameList": {
                "NameList": [
                  "[\"Agent_Status_Stopped\"]"
                ]
              },
              "CustomFilters": "ECS123",
              "KeywordFilter": {
                "Keywords": {
                  "Keywords": [
                    "VMException"
                  ]
                },
                "Relation": "OR"
              },
              "SQLFilter": "ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222"
            }
          ]
        },
        "SilenceTime": 86400
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameterValue	Illegal parameters.	O parâmetro é inválido.
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	O recurso especificado não foi encontrado.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.