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

Este tópico apresenta um exemplo de consulta aos logs de alerta do Elastic Compute Service (ECS) com base na dimensão product.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeAlertLogList	A operação a ser executada. Defina o valor como DescribeAlertLogList.
StartTime	Long	Não	1609988009694	O timestamp inicial dos logs de alerta a consultar. Unidade: milissegundos. Nota É possível consultar apenas os logs de alerta do último ano. Se o período de consulta exceder um ano, o valor retornado do parâmetro `AlertLogList` estará vazio. O intervalo entre a hora inicial (`StartTime`) e a hora final (`EndTime`) deve ser menor ou igual a 15 dias.
EndTime	Long	Não	1610074409694	O timestamp final dos logs de alerta a consultar. Unidade: milissegundos. Nota É possível consultar apenas os logs de alerta do último ano. Se o período de consulta exceder um ano, o valor retornado do parâmetro `AlertLogList` estará vazio. O intervalo entre a hora inicial (`StartTime`) e a hora final (`EndTime`) deve ser menor ou igual a 15 dias.
PageNumber	Integer	Não	1	O número da página a retornar. Valor padrão: 1.
PageSize	Integer	Não	10	A quantidade de entradas a retornar em cada página. Valor padrão: 10.
SearchKey	String	Não	alert	A palavra-chave de pesquisa usada para consultar logs de alerta.
GroupId	String	Não	7301****	O ID do grupo de aplicativos.
Namespace	String	Não	acs_ecs_dashboard	O namespace do serviço de nuvem. Nota Para obter mais informações sobre os namespaces dos serviços de nuvem, consulte Apêndice 1: Métricas.
Product	String	Não	ECS	A abreviação do nome do serviço. Para saber como obter a abreviação do nome de um serviço de nuvem, consulte DescribeProductsOfActiveMetricRule.
Level	String	Não	P4	O nível de severidade e os métodos de notificação do alerta. Valores válidos: P4: As notificações de alerta são enviadas por e-mail e robôs de chat do DingTalk. OK: Nenhum alerta é gerado.
SendStatus	String	Não	0	O status do alerta. Valores válidos: 0: O alerta foi acionado ou limpo. 1: O alerta é ineficaz. 2: O alerta está silenciado e não foi acionado em um período especificado. 3: O host está reiniciando. 4: Nenhuma notificação de alerta foi enviada. Se o valor do parâmetro SendStatus for 0, o valor P4 do parâmetro Level indica um alerta acionado e o valor OK indica um alerta limpo.
ContactGroup	String	Não	ECS_Group	O grupo de contatos de alerta.
RuleName	String	Não	test123	O nome da regra de alerta.
MetricName	String	Não	IntranetInRate	O nome da métrica. Nota Para obter mais informações sobre as métricas de diferentes serviços de nuvem, consulte Apêndice 1: Métricas.
LastMin	String	Não	360	O período estatístico dos logs de alerta. Unidade: minutos.
GroupBy	String	Não	product	A dimensão pela qual os dados são agregados. Este parâmetro equivale à cláusula 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 tanto por serviço de nuvem quanto por métrica.
RuleId	String	Não	bc369e8_30f87e517ed2fc****	O ID da regra de alerta. Para obter informações sobre como consultar o ID de uma regra de alerta, consulte DescribeMetricRuleList.

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

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	1C4A3709-BF52-42EE-87B5-7435F0929585	O ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
Code	String	200	O código de status HTTP. Nota O código de status 200 indica que a solicitação foi bem-sucedida.
Message	String	The specified resource is not found.	A mensagem de erro.
PageNumber	Integer	1	O número da página retornada.
PageSize	Integer	10	A quantidade de entradas retornadas por página.
AlertLogList	Array of Alarm		Os logs de alerta.
MetricName	String	cpu_total	O nome da métrica.
EventName	String	IOHang	O nome do evento.
Product	String	ECS	O identificador do serviço de nuvem. Valores válidos: Se o serviço de nuvem for fornecido pela Alibaba Cloud, a abreviação do nome do serviço será retornada. Exemplo: ECS. Se o serviço de nuvem não for fornecido pela Alibaba Cloud, um valor no formato `acs_Service keyword` será retornado. Exemplo: acs_networkmonitor.
BlackListUUID	String	8410dbbd-7d30-41c5-94cb-****	O identificador universalmente único (UUID) da política de lista de bloqueios.
Message	String	{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}	As informações do alerta em uma string JSON.
Namespace	String	acs_ecs_dashboard	O namespace do serviço de nuvem.
LevelChange	String	P4->OK	Indica se o nível de alerta foi alterado. Valores válidos: `P4->OK`: O nível de alerta mudou de P4 para OK. `P4->P4`: O nível de alerta permaneceu P4.
InstanceId	String	i-m5e1qg6uo38rztr4****	O ID do recurso.
RuleName	String	CPU utilization	O nome da regra de alerta.
RuleId	String	d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime	O ID da regra de alerta.
BlackListName	String	Black_Test	O nome da política de lista de bloqueios.
GroupName	String	ECS_Instances	O nome do grupo de aplicativos.
GroupId	String	7301****	O ID do grupo de aplicativos.
AlertTime	String	1610043776621	O timestamp gerado quando o alerta foi acionado. Unidade: milissegundos.
InstanceName	String	portalHost	O nome do recurso.
BlackListDetail	String	{"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"}	Os detalhes da política de lista de bloqueios.
Level	String	P4	O nível de severidade e os métodos de notificação do alerta. Valores válidos: P4: As notificações de alerta são enviadas por e-mail e robôs de chat do DingTalk. OK: Nenhum alerta é gerado.
SendStatus	String	0	O status do alerta. Valores válidos: 0: O alerta foi acionado ou limpo. 1: O alerta é ineficaz. 2: O alerta está silenciado e não foi acionado em um período especificado. 3: O host está reiniciando. 4: Nenhuma notificação de alerta foi enviada. Se o valor do parâmetro SendStatus for 0, o valor P4 do parâmetro Level indica um alerta acionado e o valor OK indica um alerta limpo.
ExtendedInfo	Array of ExtInfo		Os campos estendidos.
Name	String	userId	O nome do campo estendido.
Value	String	100931896542****	O valor do campo estendido.
Dimensions	Array of Dimensions		As dimensões do recurso que acionou os alertas.
Key	String	instanceId	A chave da dimensão.
Value	String	i-m5e1qg6uo38rztr4****	O valor da dimensão.
WebhookList	Array of WebhookList		A lista de URLs de callback.
code	String	200	O código de status do callback de alerta.
url	String	https://www.aliyun.com/webhook.html	A URL de callback.
message	String	success	A mensagem retornada para o callback de alerta.
DingdingWebhookList	Array of String	https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****	As URLs de webhook dos contatos de alerta.
ContactOnCallList	Array of String	1368888****	Os números de telefone dos contatos de alerta que podem receber chamadas telefônicas de alerta. Nota Este parâmetro é válido apenas no site da China (aliyun.com).
ContactMailList	Array of String	username@example.com	Os endereços de e-mail dos contatos de alerta.
ContactGroups	Array of String	ECS_Group	O grupo de contatos de alerta.
ContactALIIWWList	Array of String	Alice	Os IDs do TradeManager dos contatos de alerta. Nota Este parâmetro é válido apenas no site da China (aliyun.com).
ContactSMSList	Array of String	1368888****	Os números de telefone dos contatos de alerta que podem receber mensagens de texto de alerta. Nota Este parâmetro é válido apenas no site da China (aliyun.com).
ContactDingList	Array of String	CloudMonitor	Os robôs de chat do DingTalk dos contatos de alerta.
SendDetail	Object		Os detalhes sobre os resultados de envio das notificações de alerta.
ResultCode	String	success	Indica se as notificações de alerta foram enviadas. Se as notificações de alerta forem enviadas, o valor "success" será retornado. Se a configuração for inválida, nenhuma notificação de alerta será enviada e um código de erro será retornado.
ChannelResultList	Array of ChannelResult		A lista de resultados de envio categorizados por método de notificação.
Channel	String	MAIL	O método usado para enviar notificações de alerta. Valores válidos: MAIL: e-mail SMS: mensagem de texto WEBHOOK: callback de alerta SLS: Log Service ONCALL: chamada telefônica FC: Function Compute MNS: Fila do Message Service
ResultList	Array of Result		Os resultados de envio das notificações de alerta.
Code	String	200	O código de status HTTP. Se o valor do parâmetro `Channel` for `WEBHOOK`, o código de status será 200 ou 500. Se o valor do parâmetro `Channel` for `MAIL`, `SMS`, `SLS`, `ONCALL`, `FC` ou `MNS`, este parâmetro estará vazio ou não será retornado.
RequestId	String	0BDAF8A8-04DC-5F0C-90E4-724D42C4****	O ID da solicitação retornado quando o CloudMonitor chama outro serviço de nuvem.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
Detail	String	{ }	Os detalhes dos resultados retornados.
notifyTargetList	Array of String	MAIL	A lista de métodos de notificação.
Escalation	Object		A regra de alerta com base na qual o alerta foi acionado.
Expression	String	$Average<90	A descrição da regra de alerta. Nota Este parâmetro representa o conteúdo da regra de alerta. Se o valor da métrica atender à condição de alerta, um alerta será acionado.
Times	Integer	1	O número consecutivo de vezes em que o valor da métrica atende à condição de acionamento antes que um alerta seja disparado.
Level	String	P4	O nível de severidade e os métodos de notificação do alerta. Valores válidos: P4: As notificações de alerta são enviadas por e-mail e robôs de chat do DingTalk. OK: Nenhum alerta é gerado.
SendResultList	Array of SendResult		Os resultados de envio das notificações de alerta.
Key	String	MAIL	A categoria do método de notificação de alerta. Valores válidos: MAIL: e-mail ALIIM: TradeManager SMS: mensagem de texto CALL: chamada telefônica DING: Robô de chat do DingTalk Merged: mesclagem de alertas
Value	Array of String	username@example.com	O objeto de notificação correspondente ao método de notificação de alerta.
LogId	String	7510**::e8a472a0-46ae-4ac0-84b1-e46be368**	O ID do log.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeAlertLogList
&Product=ECS
&GroupBy=product
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<DescribeAlertLogListResponse>
	<AlertLogList>
		<GroupName></GroupName>
		<Message>{\"alertName\":\"d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime\",\"curLevel\":\"OK\",\"dimensions\":{\"taskId\":\"d582b9e9-b1c1-4f17-9279-0fe7333a****\",\"userId\":\"127067667954****\"},\"escalation\":{\"expression\":\"$Average>=800\",\"level\":P4,\"tag\":\"P4\",\"times\":1}</Message>
		<RuleId>d582b9e9-b1c1-4f17-9279-0fe7****_ResponseTime</RuleId>
		<Escalation>
			<Expression>$Average>=800</Expression>
			<Times>1</Times>
			<Level>P4</Level>
		</Escalation>
		<SendStatus>0</SendStatus>
		<Product>acs_ecs_dashboard</Product>
		<MetricName>cpu_total</MetricName>
		<RuleName>CPU utilization</RuleName>
		<ContactGroups>ECS_Group</ContactGroups>
		<InstanceId></InstanceId>
		<LevelChange>P4->OK</LevelChange>
		<Dimensions>
			<Value>100931896542****</Value>
			<Key>userId</Key>
		</Dimensions>
		<Dimensions>
			<Value>i-abcdefgh12****</Value>
			<Key>instanceId</Key>
		</Dimensions>
		<EventName>AlertOk</EventName>
		<ExtendedInfo>
			<Value>i-hp34y1eiszazu49y****</Value>
			<Name>instanceId</Name>
		</ExtendedInfo>
		<ExtendedInfo>
			<Value>12706****</Value>
			<Name>userId</Name>
		</ExtendedInfo>
		<Namespace>acs_ecs_dashboard</Namespace>
		<AlertTime>1610085521564</AlertTime>
		<GroupId>7301****</GroupId>
		<InstanceName>portalHost</InstanceName>
		<Level>OK</Level>
	</AlertLogList>
	<RequestId>6FCB1AB7-57F7-4DDA-B14E-6468FAFE79D9</RequestId>
	<PageSize>10</PageSize>
	<PageNumber>1</PageNumber>
	<Code>200</Code>
	<Success>true</Success>
</DescribeAlertLogListResponse>

Formato JSON

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

{
  "AlertLogList" : [ {
    "GroupName" : "",
    "ContactALIIWWList" : [ ],
    "Message" : "{\"alertName\":\"d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime\",\"curLevel\":\"OK\",\"dimensions\":{\"taskId\":\"d582b9e9-b1c1-4f17-9279-0fe7333a****\",\"userId\":\"127067667954****\"},\"escalation\":{\"expression\":\"$Average>=800\",\"level\":P4,\"tag\":\"P4\",\"times\":1}",
    "RuleId" : "d582b9e9-b1c1-4f17-9279-0f****_ResponseTime",
    "Escalation" : {
      "Expression" : "$Average>=800",
      "Times" : 1,
      "Level" : "P4"
    },
    "SendStatus" : "0",
    "Product" : "acs_ecs_dashboard",
    "MetricName" : "cpu_total",
    "ContactSMSList" : [ ],
    "RuleName" : "CPU utilization",
    "ContactGroups" : [ "ECS_Group" ],
    "DingdingWebhookList" : [ ],
    "InstanceId" : "",
    "LevelChange" : "P4->OK",
    "Dimensions" : [ {
      "Value" : "127067667954****",
      "Key" : "userId"
    }, {
      "Value" : "i-abcdefgh12****",
      "Key" : "instanceId"
    } ],
    "ContactOnCallList" : [ ],
    "ContactDingList" : [ ],
    "EventName" : "AlertOk",
    "ExtendedInfo" : [ {
      "Value" : "i-hp34y1eiszazu49y****",
      "Name" : "instanceId"
    }, {
      "Value" : "100931896542****",
      "Name" : "userId"
    } ],
    "Namespace" : "acs_ecs_dashboard",
    "AlertTime" : 1610085521564,
    "GroupId" : "7301****",
    "InstanceName" : "portalHost",
    "WebhookList" : [ ],
    "ContactMailList" : [ ],
    "Level" : "OK"
  } ],
  "RequestId" : "6FCB1AB7-57F7-4DDA-B14E-6468FAFE79D9",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Code" : 200,
  "Success" : true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	ResourceNotFound	The specified resource is not found.	O recurso especificado não foi encontrado.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.