ListAlertMessages - DataWorks: Central de Documentação do Alibaba Cloud

Consulta uma lista de mensagens de alerta.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Sim	O número da página. Valor padrão: 1. Valor mínimo: 1. Valor máximo: 30.	1
PageSize	integer	Sim	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
BeginTime	string	Sim	A hora de início do alerta. Especifique a hora em UTC no formato yyyy-MM-dd'T'HH:mm:ssZ.	2020-04-02T00:00:00+0800
EndTime	string	Sim	A hora de término do alerta. Especifique a hora em UTC no formato yyyy-MM-dd'T'HH:mm:ssZ.	2020-04-04T00:00:00+0800
RemindId	integer	Não	O ID da regra personalizada. Este parâmetro entra em vigor quando as configurações do parâmetro AlertRuleTypes são USER_DEFINE. Você só precisa fornecer as configurações de parâmetro para este parâmetro ou para o parâmetro BaselineId.	9527
AlertMethods	string	Não	O método de alerta. Valores válidos: MAIL: E-mail. SMS: Mensagem de texto. Regiões que suportam alertas por SMS: Singapura, Malásia (Kuala Lumpur) e Alemanha (Frankfurt). Separe vários métodos de alerta com vírgulas (,).	SMS,MAIL,PHONE
AlertUser	string	Não	O UID do Alibaba Cloud do destinatário do alerta.	12345
AlertRuleTypes	string	Não	O tipo de regra. Valores válidos: GLOBAL (regra global), USER_DEFINE (regra personalizada) e OTHER (outro). Separe vários tipos de regra com vírgulas (,).	GLOBAL,USER_DEFINE,OTHER
BaselineId	integer	Não	O ID da linha de base. Este parâmetro entra em vigor quando as configurações do parâmetro AlertRuleTypes são GLOBAL. Você só precisa fornecer as configurações de parâmetro para este parâmetro ou para o parâmetro RemindId.	1234

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID exclusivo da solicitação. Você pode usar o ID para solucionar problemas.	0000-ABCD-EFG****
ErrorMessage	string	A mensagem de erro.	The specified parameters are invalid.
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	object	A lista de mensagens de alerta retornadas.
PageNumber	string	O número da página atual.	1
PageSize	string	O número de entradas por página.	10
TotalCount	string	O número total de mensagens de alerta.	100
AlertMessages	array<object>	A lista de mensagens de alerta.
	array<object>	A mensagem de alerta.
RemindId	integer	O ID da regra de monitoramento personalizada acionada. Este parâmetro é retornado quando o parâmetro Source é definido como REMIND_ALERT.	1234
AlertMessageStatus	string	O status de envio. Valores válidos: READY_TO_SEND (pronto para enviar), SEND_FAIL (falha no envio), SEND_SUCCESS (envio bem-sucedido) e SEND_OVERLIMIT (limite de alerta excedido).	READY_TO_SEND
AlertUser	string	O UID do Alibaba Cloud do destinatário.	9527952795****
AlertTime	integer	O carimbo de data e hora do alerta.	1553531401000
AlertMethod	string	O método de alerta. Valores válidos: MAIL (e-mail), SMS (mensagem de texto) e PHONE (chamada telefônica, suportada apenas no DataWorks Professional Edition ou em uma edição superior).	SMS
Source	string	A origem do alerta. Valores válidos: REMIND_ALERT (alerta personalizado), TOPIC_ALERT (alerta de evento), SLA_ALERT (alerta de linha de base), NODE_CYCLE_ALERT (alerta de loop de nó) e NODE_LONELY_ALERT (alerta de nó isolado).	REMIND_ALERT
Content	string	O conteúdo do alerta.	Node error
RemindName	string	O nome da regra de monitoramento personalizada acionada. Este parâmetro é retornado quando o parâmetro Source é definido como REMIND_ALERT.	Custom monitoring rule name
AlertId	integer	O ID do alerta.	1234
Instances	array<object>	A lista de instâncias que acionaram a regra de monitoramento personalizada. Este parâmetro é retornado quando o parâmetro Source é definido como REMIND_ALERT. Para outras origens de alerta, este parâmetro está vazio.
	object	As informações da instância.
Status	string	O status da instância. Valores válidos: NOT_RUN (não executado), WAIT_TIME (aguardando o horário agendado), WAIT_RESOURCE (aguardando recursos), RUNNING (em execução), CHECKING (verificando), CHECKING_CONDITION (verificando condições), FAILURE (falhou) e SUCCESS (bem-sucedido).	NOT_RUN
InstanceId	integer	O ID da instância.	12345
NodeName	string	O nome do nó.	Node name
NodeId	integer	O ID do nó.	1234
ProjectId	integer	O ID do workspace ao qual o nó pertence.	1234
Topics	array<object>	A lista de eventos que acionaram o alerta. Este parâmetro é retornado quando o parâmetro Source é definido como TOPIC_ALERT (alerta de evento global). Para outras origens de alerta, este parâmetro está vazio.
	object	As informações do evento.
TopicName	string	O nome do evento.	9527 error
InstanceId	integer	O ID da instância associada ao evento.	12345
TopicId	integer	O ID do evento.	1234
TopicOwner	string	O UID do Alibaba Cloud do proprietário do evento.	9527952795****
NodeId	integer	O ID do nó associado ao evento.	1234
TopicStatus	string	O status do evento. Valores válidos: IGNORE (ignorado), NEW (novo), FIXING (corrigindo) e RECOVER (recuperado).	FIXING
Nodes	array<object>	A lista de nós retornados varia de acordo com a origem do alerta: Se o parâmetro Source for definido como NODE_CYCLE_ALERT, os nós que formam um loop serão retornados. Se o parâmetro Source for definido como NODE_LONELY_ALERT, os nós isolados serão retornados.
	object	As informações do nó.
Owner	string	O UID do Alibaba Cloud do proprietário do nó.	95279527952****
NodeName	string	O nome do nó.	Node name
NodeId	integer	O ID do nó.	1234
ProjectId	integer	O ID do workspace ao qual o nó pertence.	1234
SlaAlert	object	As informações básicas da instância que acionaram o alerta de linha de base. Este parâmetro é retornado quando o parâmetro Source é definido como SLA_ALERT. Para outras origens de alerta, este parâmetro está vazio.
Status	string	O status da linha de base. Valores válidos: ERROR (erro), SAFE (seguro), DANGROUS (aviso) e OVER (excedido).	SAFE
BaselineOwner	string	Os UIDs do Alibaba Cloud dos proprietários da linha de base. Vários UIDs são separados por vírgulas (,).	952795279****
BaselineId	integer	O ID da linha de base.	1234
BaselineName	string	O nome da linha de base.	Baseline name
Bizdate	integer	O carimbo de data e hora da data de negócios para a instância da linha de base.	1553443200000
ProjectId	integer	O ID do workspace ao qual a linha de base pertence.	1234
InGroupId	integer	O número do ciclo da instância da linha de base. O valor é 1 para linhas de base diárias e varia de 1 a 24 para linhas de base horárias.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": "1",
    "PageSize": "10",
    "TotalCount": "100",
    "AlertMessages": [
      {
        "RemindId": 1234,
        "AlertMessageStatus": "READY_TO_SEND",
        "AlertUser": "9527952795****",
        "AlertTime": 1553531401000,
        "AlertMethod": "SMS",
        "Source": "REMIND_ALERT",
        "Content": "Node error",
        "RemindName": "Custom monitoring rule name",
        "AlertId": 1234,
        "Instances": [
          {
            "Status": "NOT_RUN",
            "InstanceId": 12345,
            "NodeName": "Node name",
            "NodeId": 1234,
            "ProjectId": 1234
          }
        ],
        "Topics": [
          {
            "TopicName": "9527 error",
            "InstanceId": 12345,
            "TopicId": 1234,
            "TopicOwner": "9527952795****",
            "NodeId": 1234,
            "TopicStatus": "FIXING"
          }
        ],
        "Nodes": [
          {
            "Owner": "95279527952****",
            "NodeName": "Node name",
            "NodeId": 1234,
            "ProjectId": 1234
          }
        ],
        "SlaAlert": {
          "Status": "SAFE",
          "BaselineOwner": "952795279****",
          "BaselineId": 1234,
          "BaselineName": "Baseline name",
          "Bizdate": 1553443200000,
          "ProjectId": 1234,
          "InGroupId": 1
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Você não tem as permissões necessárias. Conceda as permissões primeiro.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.Resource	You have reached the limit for the resource. Please contact us by submitting a ticket.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.