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 Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NamePrefix	string	Não	O prefixo no nome da regra de alerta acionada por eventos.	test
PageNumber	string	Não	O número da página. As páginas começam na página 1. Valor padrão: 1.	1
PageSize	string	Não	O número de entradas por página. As páginas começam na página 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 (padrão) false	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As regras de alerta acionadas por eventos.
Code	string	O código de status HTTP. Nota O código de status 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem de erro retornada.	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 retornadas.	21
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
EventRules	object
EventRule	array<object>	A regra de alerta acionada por eventos.
	array<object>
EventType	string	The type of the event-triggered alert rule. Valid values: SYSTEM: system event-triggered alert rule CUSTOM: custom event-triggered alert rule	SYSTEM
Description	string	The description of the event-triggered alert rule.	Default group event rule.
GroupId	string	The ID of the application group.	7378****
Name	string	The name of the event-triggered alert rule.	test_DefaultEventRule_7378****
State	string	The status of the event-triggered alert rule. Valid values: ENABLED DISABLED	ENABLED
EventPattern	object
EventPattern	array<object>	The mode of the event-triggered alert rule.
	array<object>
Product	string	The abbreviation of the Alibaba Cloud service name.	CloudMonitor
LevelList	object
LevelList	array	The levels of the event-triggered alerts.
	string	The level of the event-triggered alert. Valid values: CRITICAL WARN INFO	CRITICAL
EventTypeList	object
EventTypeList	array	The types of the event-triggered alert rules.
	string	The type of the event-triggered alert rule. `*` indicates all types of alert rules.	*
NameList	object
NameList	array	The event names.
	string	The event name.	["Agent_Status_Stopped"]
CustomFilters	string	The custom filter conditions.	ECS123
KeywordFilter	object	The keyword for filtering.
Keywords	object
Keywords	array	The keywords that are used to match events.
	string	The keyword.	VMException
Relation	string	The relationship between multiple keywords in a condition. Valid values: OR: The relationship between keywords is OR. NOT: The keyword is excluded. The value NOT indicates that all events that do not contain the keywords are matched.	OR
SQLFilter	string	Indicates that logs are filtered based on the specified SQL statement. If the specified conditions are met, an alert is triggered.	ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222
SilenceTime	integer	The mute period during which new alert notifications are not sent even if the trigger conditions are met.	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.	Illegal parameters.
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.	The specified resource is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.