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

Consulta o histórico de alertas ao chamar a operação DescribeAlertLogList.

Descrição da operação

Esta operação pode consultar o histórico de alertas apenas no último ano.

Este tópico fornece um exemplo para mostrar como consultar o histórico de alertas do Elastic Compute Service (ECS) a partir da dimensão product do serviço de nuvem.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
StartTime	integer	Não	O início do intervalo de tempo para consultar o histórico de alertas. Unidade: milissegundos. Você pode consultar apenas o histórico de alertas do último ano. Se o intervalo de tempo da consulta exceder um ano, o valor retornado do parâmetro AlertLogList estará vazio. Nota O intervalo entre a hora de início (StartTime) e a hora de término (EndTime) deve ser menor ou igual a 15 dias. Ambos os parâmetros devem ser especificados ou não especificados ao mesmo tempo. Se não forem especificados, o histórico de alertas dos últimos 15 minutos será consultado por padrão.	1609988009694
EndTime	integer	Não	O fim do intervalo de tempo para consultar o histórico de alertas. Unidade: milissegundos. Você pode consultar apenas o histórico de alertas do último ano. Se o intervalo de tempo da consulta exceder um ano, o valor retornado do parâmetro AlertLogList estará vazio. Nota O intervalo entre a hora de início (StartTime) e a hora de término (EndTime) deve ser menor ou igual a 15 dias. Ambos os parâmetros devem ser especificados ou não especificados ao mesmo tempo. Se não forem especificados, o histórico de alertas dos últimos 15 minutos será consultado por padrão.	1610074409694
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
SearchKey	string	Não	A palavra-chave usada para consultar o histórico de alertas.	alert
GroupId	string	Não	O ID do grupo de aplicativos.	7301****
Namespace	string	Não	O namespace do serviço de nuvem. Nota Para obter mais informações sobre os namespaces dos serviços de nuvem, consulte Metrics.	acs_ecs_dashboard
Product	string	Não	A abreviação do nome do serviço de nuvem. Para obter mais informações sobre como obter a abreviação do nome de um serviço de nuvem, consulte DescribeProductsOfActiveMetricRule.	ECS
Level	string	Não	O nível do alerta e os métodos de notificação. Valores válidos: P4: e-mails e chatbots do DingTalk. OK: sem alertas.	P4
SendStatus	string	Não	O status do alerta. Valores válidos: 0: Um alerta é acionado ou resolvido. 1: A hora atual não está dentro do período efetivo do alerta. 2: A hora atual está dentro do período de silêncio do canal. 3: O host está sendo reiniciado. 4: Nenhum alerta é enviado. Quando o status do alerta é 0, um alerta é acionado se Level estiver definido como P4; o alerta é resolvido se Level estiver definido como OK.	0
ContactGroup	string	Não	O grupo de contatos de alerta.	ECS_Group
RuleName	string	Não	O nome da regra de alerta.	test123
MetricName	string	Não	O nome da métrica. Nota Para obter mais informações sobre as métricas dos serviços de nuvem, consulte Metrics.	IntranetInRate
LastMin	string	Não	O intervalo no qual os logs são obtidos. Unidade: minutos.	360
GroupBy	string	Não	A dimensão espacial pela qual os dados são agregados, o que equivale ao Group By em SQL. Valores válidos: product: agrega dados por serviço de nuvem. level: agrega dados por nível de alerta. groupId: agrega dados por grupo de aplicativos. contactGroup: agrega dados por grupo de contatos de alerta. product,metricName: agrega dados por serviço de nuvem e métrica.	product
RuleId	string	Não	O ID da regra de alerta. Para obter mais informações sobre como consultar o ID de uma regra de alerta, consulte DescribeMetricRuleList.	bc369e8_30f87e517ed2fc****
SourceType	string	Não	O tipo da regra de alerta. Valor válido: METRIC, que indica uma regra de alerta de métrica de série temporal.	METRIC
EventType	string	Não	O tipo de alerta. Valores válidos: TRIGGERED: O alerta é acionado. RESOLVED: O alerta é resolvido.	TRIGGERED

Para obter mais informações sobre os parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Nenhum.
RequestId	string	O ID da solicitação.	1C4A3709-BF52-42EE-87B5-7435F0929585
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.	true
Code	string	O código de status HTTP. Nota O código de status 200 indica que a chamada foi bem-sucedida.	200
Message	string	A mensagem de erro.	The specified resource is not found.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
AlertLogList	array<object>	A lista de entradas do histórico de alertas.
	array<object>	Nenhum.
MetricName	string	O nome da métrica.	cpu_total
EventName	string	O nome do evento.	IOHang
Product	string	O identificador do serviço de nuvem. Valores válidos: Para um serviço da Alibaba Cloud, o valor é a abreviação do nome do serviço de nuvem. Exemplo: ECS. Para um serviço não pertencente à Alibaba Cloud, o valor está no formato acs_Palavra-chave do produto. Exemplo: acs_networkmonitor.	ECS
BlackListUUID	string	O UUID da lista de bloqueio de alertas correspondente.	8410dbbd-7d30-41c5-94cb-****
Message	string	As informações relacionadas ao alerta, que são uma string JSON.	{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}
Namespace	string	O namespace do serviço de nuvem.	acs_ecs_dashboard
LevelChange	string	A alteração do nível do alerta. Valores válidos: P4->OK: O nível do alerta muda de P4 para OK, o que indica que o alerta foi resolvido. P4->P4: indica um alerta de nível P4.	P4->OK
InstanceId	string	O ID do recurso.	i-m5e1qg6uo38rztr4****
RuleName	string	O nome da regra de alerta.	CPU utilization
RuleId	string	O ID da regra de alerta.	d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime
BlackListName	string	O nome da lista de bloqueio de alertas correspondente.	Black_Test
GroupName	string	O nome do grupo de aplicativos.	ECS_Instances
GroupId	string	O ID do grupo de aplicativos.	7301****
AlertTime	string	O carimbo de data e hora em que o alerta foi acionado. Unidade: milissegundos.	1610043776621
InstanceName	string	O nome do recurso.	portalHost
BlackListDetail	string	Os detalhes da lista de bloqueio de alertas correspondente.	{"id":12**,"metricProject":"acs_ecs_dashboard","userId":173651113438,"uuid":"8410dbbd-7d30-41c5-94cb-","name":"alert-","productCategory":"ecs","instances":[{"instanceId":"i-m5e1qg6uo38rztr4**"}],"metrics":null,"scopeType":"USER","scopeValue":"","startTime":"0001-01-01T00:00:00Z","endTime":"9999-12-31T23:59:59.999999999+08:00","effectiveTime":null,"isEnable":true,"status":1,"gmtCreate":"2021-11-02T16:35:59+08:00","gmtModified":"2021-11-02T16:35:59+08:00","loadTime":"2021-11-02T16:36:15.213072177+08:00"}
Level	string	O nível do alerta e os métodos de notificação. Valores válidos: P4: e-mails e chatbots do DingTalk. OK: sem alertas.	P4
SendStatus	string	O status do alerta. Valores válidos: 0: Um alerta é acionado ou resolvido. 1: A hora atual não está dentro do período efetivo do alerta. 2: A hora atual está dentro do período de silêncio do canal. 3: O host está sendo reiniciado. 4: Nenhum alerta é enviado. Quando o status do alerta é 0, um alerta é acionado se Level estiver definido como P4; o alerta é resolvido se Level estiver definido como OK.	0
ExtendedInfo	array<object>	As informações estendidas do alerta.
	object	Nenhum.
Name	string	The name of the extension field.	userId
Value	string	The value of the extension field.	100931896542****
Dimensions	array<object>	As dimensões do recurso para o qual o alerta é acionado.
	object	Nenhum.
Key	string	The key of the alerting resource.	instanceId
Value	string	The value of the alerting resource.	i-m5e1qg6uo38rztr4****
WebhookList	array<object>	A lista de URLs que recebem callback quando o alerta é acionado.
	object	Nenhum.
code	string	The status code returned for the alert callback.	200
url	string	The URL that is called back when the alert is triggered.	https://www.aliyun.com/webhook.html
message	string	The information returned for the alert callback.	success
DingdingWebhookList	array	A lista de URLs de webhook dos chatbots do DingTalk para o contato de alerta.
	string	A lista de URLs de webhook dos chatbots do DingTalk para o contato de alerta.	https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****
ContactOnCallList	array	A lista de números de telefone do contato de alerta.
	string	A lista de números de telefone do contato de alerta. Nota Este parâmetro é aplicável apenas ao site da China.	1368888****
ContactMailList	array	A lista de endereços de e-mail do contato de alerta.
	string	A lista de endereços de e-mail do contato de alerta.	username@example.com
ContactGroups	array	A lista de grupos de contatos de alerta.
	string	O grupo de contatos de alerta.	ECS_Group
ContactALIIWWList	array	A lista de IDs do Wangwang do contato de alerta.
	string	A lista de IDs do Wangwang do contato de alerta. Nota Este parâmetro é aplicável apenas ao site da China.	Alice
ContactSMSList	array	A lista de números de telefone que recebem mensagens de texto do contato de alerta.
	string	A lista de números de telefone que recebem mensagens de texto do contato de alerta. Nota Este parâmetro é aplicável apenas ao site da China.	1368888****
ContactDingList	array	A lista de contas do DingTalk do contato de alerta.
	string	A lista de contas do DingTalk do contato de alerta.	CloudMonitor
SendDetail	object	Os detalhes do resultado do envio do alerta.
ResultCode	string	The pushing status of the alert information. success: The alert was pushed. error code: If a configuration error occurs and the pushing list is empty, an error code is displayed.	success
ChannelResultList	array<object>	The list of alert pushing results by alert channel.
	array<object>	The alert pushing result by alert channel.
Channel	string	The alert pushing channel. Valid values: MAIL: email. SMS: text message. WEBHOOK: alert callback. SLS: Log Service. ONCALL: phone call. FC: Function Compute. MNS: Message Service (MNS).	MAIL
ResultList	array<object>	The list of alert information results that CloudMonitor sends to the alert channel.
	object	The alert information result that CloudMonitor sends to the alert channel.
Code	string	The status code. If `Channel` is set to `WEBHOOK`, the status code is 200 or 500. If `Channel` is set to `MAIL`, `SMS`, `SLS`, `ONCALL`, `FC`, or `MNS`, this parameter is unavailable or empty.	200
RequestId	string	The request ID returned by calling another cloud service.	0BDAF8A8-04DC-5F0C-90E4-724D42C4****
Success	boolean	The result of calling the target. true: The call was successful. false: The call failed.	true
Detail	string	The details of the returned result.	{ }
notifyTargetList	array	The list of channel notifications.
	string	The list of channel notifications.	MAIL
Escalation	object	A regra que aciona o alerta.
Expression	string	The description of the rule that triggers the alert. Nota The body of the alert rule. An alert rule is triggered when the monitoring data meets the alert conditions.	$Average<90
Times	integer	The number of times that the alert is retried.	1
Level	string	The alert level and notification methods. Valid values: P4: emails and DingTalk chatbots. OK: no alerts.	P4
SendResultList	array<object>	A lista de resultados de envio de alerta.
	object	A lista de resultados de envio de alerta.
Key	string	The channel that sends the alert. Valid values: MAIL: email. ALIIM: Wangwang. SMS: text message. CALL: phone call. DING: DingTalk chatbot. Merged: alert combination.	MAIL
Value	array	The notification target that corresponds to the alert channel.
	string	The notification target that corresponds to the alert channel.	username@example.com
LogId	string	O ID do log.	7510**::e8a472a0-46ae-4ac0-84b1-e46be368**

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "1C4A3709-BF52-42EE-87B5-7435F0929585",
  "Success": true,
  "Code": "200",
  "Message": "The specified resource is not found.",
  "PageNumber": 1,
  "PageSize": 10,
  "AlertLogList": [
    {
      "MetricName": "cpu_total",
      "EventName": "IOHang",
      "Product": "ECS",
      "BlackListUUID": "8410dbbd-7d30-41c5-94cb-****",
      "Message": "{\"alertName\":\"e47aa0ac-4076-44db-a47d-d1083968****_Availability\"}",
      "Namespace": "acs_ecs_dashboard",
      "LevelChange": "P4->OK",
      "InstanceId": "i-m5e1qg6uo38rztr4****",
      "RuleName": "CPU utilization",
      "RuleId": "d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime",
      "BlackListName": "Black_Test",
      "GroupName": "ECS_Instances",
      "GroupId": "7301****",
      "AlertTime": "1610043776621",
      "InstanceName": "portalHost",
      "BlackListDetail": "{\"id\":12****,\"metricProject\":\"acs_ecs_dashboard\",\"userId\":173651113438****,\"uuid\":\"8410dbbd-7d30-41c5-94cb-****\",\"name\":\"alert-****\",\"productCategory\":\"ecs\",\"instances\":[{\"instanceId\":\"i-m5e1qg6uo38rztr4****\"}],\"metrics\":null,\"scopeType\":\"USER\",\"scopeValue\":\"\",\"startTime\":\"0001-01-01T00:00:00Z\",\"endTime\":\"9999-12-31T23:59:59.999999999+08:00\",\"effectiveTime\":null,\"isEnable\":true,\"status\":1,\"gmtCreate\":\"2021-11-02T16:35:59+08:00\",\"gmtModified\":\"2021-11-02T16:35:59+08:00\",\"loadTime\":\"2021-11-02T16:36:15.213072177+08:00\"}",
      "Level": "P4",
      "SendStatus": "0",
      "ExtendedInfo": [
        {
          "Name": "userId",
          "Value": "100931896542****"
        }
      ],
      "Dimensions": [
        {
          "Key": "instanceId",
          "Value": "i-m5e1qg6uo38rztr4****"
        }
      ],
      "WebhookList": [
        {
          "code": "200",
          "url": "https://www.aliyun.com/webhook.html",
          "message": "success"
        }
      ],
      "DingdingWebhookList": [
        "https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****"
      ],
      "ContactOnCallList": [
        "1368888****"
      ],
      "ContactMailList": [
        "username@example.com"
      ],
      "ContactGroups": [
        "ECS_Group"
      ],
      "ContactALIIWWList": [
        "Alice"
      ],
      "ContactSMSList": [
        "1368888****"
      ],
      "ContactDingList": [
        "CloudMonitor"
      ],
      "SendDetail": {
        "ResultCode": "success",
        "ChannelResultList": [
          {
            "Channel": "MAIL",
            "ResultList": [
              {
                "Code": "200",
                "RequestId": "0BDAF8A8-04DC-5F0C-90E4-724D42C4****",
                "Success": true,
                "Detail": "{ }",
                "notifyTargetList": [
                  "MAIL"
                ]
              }
            ]
          }
        ]
      },
      "Escalation": {
        "Expression": "$Average<90",
        "Times": 1,
        "Level": "P4"
      },
      "SendResultList": [
        {
          "Key": "MAIL",
          "Value": [
            "username@example.com"
          ]
        }
      ],
      "LogId": "7510****::e8a472a0-46ae-4ac0-84b1-e46be368****"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ParameterInvalid	Parameter invalid.
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.
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.